Webhooks
Webhooks allow to notify custom endpoints about validation result.
1. Creating Webhook
Create webhook here
Enter the URL that should be triggered when validation happens. You can also add custom headers that will be sent along with validation data.
Note
URL should be valid and accept POST requests.
You should see the newly created webhook in the list
2. Creating request
Create validation request either by iFrame component or SMS
3. Receiving data
When validation process is complete all registered and enabled webhooks will receive POST request containing webhook event.
Note
We have a retry policy set to 10 retries before considering a webhook endpoint unreachable.
Request example:
[POST] https://my.webhook.com/url
{
"Id":2014,
"Created":"2020-07-23T09:31:25.6675069Z",
"Data":"{\"ValidationResponseId\":2024,\"ValidationRequestId\":\"f5f02a72-6bc4-4651-9eb5-08d82edcbb8d\",\"DocumentType\":1,\"Document\":{\"IDType\":\"DL\",\"Country\":\"United States\",\"AbbrCountry\":\"US\",\"Abbr3Country\":\"USA\",\"ID\":\"088720519\",\"DOB\":\"1994-08-09\",\"Issued\":\"2015-08-14\",\"Expires\":\"2021-08-09\",\"FullName\":\"POPPENHAGEN,LINDSAY\",\"PrivateName\":\"PARKER MORGAN\",\"FamilyName\":\"POPPENHAGEN\",\"City\":\"GREENWICH\",\"State\":\"CT\",\"Zip\":\"06831-5325\",\"Address\":\"15 DEARFIELD LN\",\"Class\":\"D\",\"Gender\":\"Female\",\"Height\":\"5'05\\\"\",\"Eyes\":\"Green\",\"Hair\":null,\"Weight\":null,\"Template\":\"US_OH3\",\"FirstName\":\"LINDSAY\",\"MiddleName\":\"MORGAN\"},\"AttemptsLeft\":14,\"Status\":1,\"ValidationStatus\":{\"Expired\":false,\"DocumentIsValid\":false,\"FaceIsValid\":true},\"InvalidDataErrors\":null}",
"EventType":1
}
Id
– identifier of the current webhook event. It is unique for every validation requestCreated
– webhook event creation dateData
– contains JSON formatted data with parsed document data and validation resultEventType
– indicates type of the event connected with the validation result- 0 - Success. Document passed checks
- 1 - Fail. Document failed one or more checks
- 2 - InvalidData. Validation request contains invalid data
- 3 - Error. Service error