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

{
  "applicantId": "140000249274x80293840283",
  "status": "Reviewed",
  "reviewAnswer": "Rejected",
  "rejectLabels": [
    "SANCTIONS",
    "COMPROMISED_PERSONS"
  ],
  "entityType": "AUSTRALIAN PROPRIETARY COMPANY, LIMITED BY SHARES",
  "registrySource": "AUSTRALIAN SECURITIES & INVESTMENTS COMMISSION",
  "registeredAddress": "123 EXAMPLE LANE, PERTH, 6000, WA, AUSTRALIA",
  "companyName": "EXAMPLE LTD",
  "registrationNumber": "123 456 789",
  "incorporatedOn": "2020-12-01",
  "representativeEmail": "[e-mail]",
  "representativePhone": "0400 000 000",
  "flowQuestions": [
    "Example Question 1",
    "Example Question 2"
  ],
  "flowAnswers": [
    "Entity Answer 1",
    "Entity Answer 2"
  ],
  "flow": "KYB Basic"
  "sourceKey": "Example Source Key",
  "externalUserId": []
}