October 2023 Update

Enhance trust and risk assessments with our latest API feature delivering concise reason codes directly in API and Batch Export, plus important updates on customer_id usage in API calls.

API: Reason Codes

we've just released a new feature that allows TRUST and RISK signals to be returned via API and, BATCH EXPORT. 🎉

Previously TRUST and RISK were only available in the CLOUD DASHBOARD.

The API consumer will receive trust/risk for each product under the reason_codes field.

To keep the payload compact we only return codes such as TP001,RI003,TE005

Here's an extract from the API:

{  
  "score":{
   "reason_codes": "TP004,TP003"
    ...
  },
  "phone": {  
    ...
  	"reason_codes": "TP004,TP003"
    ...
  	},
"email": {
    ...
    "reason_codes": "TE004,TE002,TE003"
    ...
    },
}

To translate the codes a customer can:

Look at this page: Reason Code Guide
Make an API call and get the full list. Documented here: Reason Code Catalog API

An extract from the reason-codes-catalog-api:

{  
  "RE011": {  
    "name": "Email Data Breaches",  
    "type": "RISK",  
    "description": "This email address is present in much more data breach than usual, indicating a shared email"  
  },  
  "RE005": {  
    "name": "Email Status",  
    "type": "RISK",  
    "description": "This email address is undeliverable and has an invalid status"  
  }
}

DEPRECATED: multiple API calls with the same customer_id

Removal date is scheduled for 2024-01-31

Following our deprecation plan for the customer_id identity merge. We will not support multiple calls on the same customer_id even in the form of a profile integration.

What is a profile integration?

Profile integration is when an API request is sent to our system with a subset of data.

API CALL 1 -> customer_id_000 + PHONE + EMAIL

API CALL 2 -> customer_id_000 + IP

Currently, we perform a merge of the two requests into the same customer_id (in this case customer_id_000)

Resulting in an identity with PHONE + EMAIL + IP

The change

In the API request, multiple subsequent calls with the same customer_id will not be supported.

For this reason, we're now enforcing a new customer ID for every API call.

Profile integration will be deprecated and will be removed at the specified date.

After the removal date, you will receive a 400 BAD REQUEST.

Will this impact my API integration?

This change is possibly breaking for your integration if:

You make multiple API calls with the same customer_id and incrementally provide products.

How to mitigate this situation:

Whenever a profile integration is necessary provide a new customer_id.