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 entity verification results endpoint, you can set up a webhook that sends the verification status and 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": {
        "applicantId": "4242424242424x424242424242424242",
        "applicantStatus": "Reviewed",
        "reviewAnswer": "Approved",
        "createdDate": "12/09/2024",
        "rejectLabels": [],
        "entityName": "ABC Pty Ltd",
        "registrationNumber": "000000000",
        "entityType": "Australian Proprietary Company, Limited By Shares",
        "incorporatedOn": "12/12/2020",
        "entityCountry": "AUS",
        "registrySource": "Australian Securities & Investments Commission",
        "registeredAddress": "123 Example Lane, Perth, 6000, WA, Australia",
        "representativeEmail": "example@personrco",
        "representativePhone": "0400000000",
        "flowQuestions": [
            "Question 1",
            "Question 2"
        ],
        "flowAnswers": [
            "Answer 1",
            "Answer 2"
        ]
    }
}