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

{
    "status": "success",
    "response": {
        "applicantStatus": "Reviewed",
        "applicantActionStatus": "Reviewed",
        "result": {
            "Modified Date": 1709088258859,
            "Created Date": 1699237071350,
            "reviewAnswer": "Approved",
            "applicant": "1699236591586x0000000000000000000",
            "company": "1668816503943x0000000000000000000",
            "rejectLabels": [],
            "verification": "1699236590532x0000000000000000000",
        },
        "extractedFirstName": "JOHN DEREK",
        "extractedLastName": "SAMPLE",
        "extractedBirthDate": "1995-10-23",
        "documentCountry": "AUS",
        "extractedStreetNum": "123",
        "extractedStreet": "SAMPLE LANE",
        "extractedCity": "PERTH",
        "extractedState": "WESTERN AUSTRALIA",
        "extractedPostCode": "6000"
    }
}