/
Experian check performed

Experian check performed
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of Experian check-related webhook event.

customerIdstring, <= 50 characters(CustomerId)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
outcomeinteger

Check decision where 1 - record matches, 0 - no matches found, -1 - record mismatches.

Enum:-101
Example:1
reasonstring

Text representation of the outcome.

Example:"Individual has a 90 percent or greater match to forename surname premise postcode with ID verified and DOB"
errorCodestring

Error code produced by the Experian system.

Example:"001"
errorMessagestring

Error message produced by the Experian system.

Example:"Authentication Error: Bad Username or Password"
eventTypestring

Type of event that triggered the webhook.

Value:"experian-check-performed"
_embeddedobject

Embedded objects related to the Experian check event.

Payload
{
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "outcome": 1,
  "reason": "Individual has a 90 percent or greater match to forename surname premise postcode with ID verified and DOB",
  "errorCode": "001",
  "errorMessage": "Authentication Error: Bad Username or Password",
  "eventType": "experian-check-performed",
  "_embedded": {
    "customer": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.