Setting up a webhook
Instead of retrieving verification results, you can use a webhook that sends results automatically.
Rather than manually retrieving results using the Retrieving applicant verification results endpoint, you can set up a webhook that sends the verification status and extracted data to your API once a verification has finished processing.
Providing us your endpoint URL is easy. Simply head to https://enterprise.personr.co/dashboard/dev-space and click on Webhooks.
Enter your API endpoint that's listening, and hit Save.

Be sure to generate a webhook authentication token, and only accept authenticated calls from us. We'll send a POST request to your endpoint, with your generated token in the header.
Webhook Response
rejectLabel
One string. Several labels are comma-separated, e.g. "FORGERY, CRIMINAL".
externalUserId
A JSON-encoded string, e.g. "[\"user_123\"]". Parse it to get the array.
rejectType
"Final" or "Retry" when rejected, otherwise null.
Delivery and retries
We send each webhook as a POST with a JSON body (Content-Type: application/json). Respond with any 2xx status within a few seconds, and process the event asynchronously if you need longer.
If your endpoint returns a non-2xx status or doesn't respond, we retry up to 5 times:
1
When the event happens
2
1 minute after attempt 1
3
5 minutes after attempt 2
4
30 minutes after attempt 3
5
2 hours after attempt 4
6
12 hours after attempt 5
Each retry carries the current state of the record, so treat webhooks as notifications and de-duplicate on applicantId (and event, where present). Once a delivery succeeds, no further retries are sent. If a webhook still fails after the last retry, call the Retrieving applicant verification results endpoint to catch up.
The same delivery and retry rules apply to the onboarding webhooks.
Last updated
Was this helpful?