NAV
shell

Introduction

Welcome to the Disputify API. You can use our API to access Disputify API endpoints, which can generate scores on order data you provide.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct api_token with each request
curl "https://app.disputify.com/api/v1/scoring/score?api_token=XXX"

Make sure to replace XXX with your API key.

Disputify uses API keys to allow access to the API. You can register a new Disputify API key at our developer portal.

Disputify expects for the API key to be included in all API requests to the server in a URL param that looks like the following:

api_key=XXX

Scoring

Get order score

curl "https://app.disputify.com/api/v1/scoring/score?api_token=XXX&email=demo@example.org"

The above command returns JSON structured like this:

{
   "score":90.88,
   "markers":[
      {
         "marker_type":"normalized_email",
         "created_at":"2021-02-15T04:51:09.239Z",
         "source_type":"Refund",
         "source_id":238,
         "id":3716,
         "permitted_customer":null
      },
      {
         "marker_type":"normalized_email",
         "created_at":"2021-02-15T04:51:19.232Z",
         "source_type":"Refund",
         "source_id":239,
         "id":3734,
         "permitted_customer":null
      },
      {
         "marker_type":"normalized_email",
         "created_at":"2021-02-15T04:41:46.254Z",
         "source_type":"Customer",
         "source_id":267,
         "id":3680,
         "permitted_customer":null
      },
      {
         "marker_type":"normalized_email",
         "created_at":"2021-02-15T04:48:41.241Z",
         "source_type":"Refund",
         "source_id":237,
         "id":3698,
         "permitted_customer":null
      }
   ]
}

This endpoint retrieves the score for the provided query params.

HTTP Request

GET https://app.disputify.com/api/v1/scoring/score

Query Parameters

Parameter Optional Description
email no Email for the order
first_name yes First name for the order
last_name yes Last name for the order
phone_number yes Phone number for the order
billing_address[address_1] yes Billing address line 1
billing_address[address_2] yes Billing address line 1
billing_address[city] yes Billing city/suburb
billing_address[state] yes Billing state/province
billing_address[postcode] yes Billing post/zipcode
billing_address[country] yes Billing country
shipping_address[address_1] yes Shipping address line 1
shipping_address[address_2] yes Shipping address line 1
shipping_address[city] yes Shipping city/suburb
shipping_address[state] yes Shipping state/province
shipping_address[postcode] yes Shipping post/zipcode
shipping_address[country] yes Shipping country

Response

Top level key Description
score Disputify risk score from 0-100

Markers in the response are fraud indicators that are matched, each marker payload is broken down as follows:

Marker Key Description
marker_type Type of fraud marker
created_at Import date of fraud marker
source_type The original generator of the fraud marker
source_id The ID of the originato
id ID of the fraud marker
permitted_customer This indicates the user has been approved

Get a Specific Order score

curl "https://app.disputify.com/api/v1/orders/1234/score?api_token=XXX"

The above command returns JSON structured like this:

{
   "score":20.88,
   "markers":[
      {
         "marker_type":"normalized_email",
         "created_at":"2021-02-15T04:51:09.239Z",
         "source_type":"Refund",
         "source_id":238,
         "id":3716,
         "permitted_customer":null
      }
   ]
}

This endpoint retrieves a specific order's score.

HTTP Request

GET https://app.disputify.com/api/v1/orders/<ID>

URL Parameters

Parameter Description
ID The ID of the order to retrieve

Errors

The Disputify API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The order requested is hidden for administrators only.
404 Not Found -- The specified order could not be found.
405 Method Not Allowed -- You tried to access a order with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The order requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many orders Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.