> For the complete documentation index, see [llms.txt](https://manual.personr.co/api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.personr.co/api-documentation/applicant-results/retrieving-applicant-verification-results/setting-up-a-webhook.md).

# Setting up a webhook

Rather than manually retrieving results using the [Retrieving applicant verification results](/api-documentation/applicant-results/retrieving-applicant-verification-results.md) 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.

<figure><img src="/files/5SVXB2FGSot7XP6Wvid9" alt=""><figcaption></figcaption></figure>

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.&#x20;

#### Webhook Response

```json
{
  "applicantId": "14000394983x200039203940",
  "actionStatus": "Reviewed",
  "reviewAnswer": "Rejected",
  "rejectLabels": [
    "FORGERY",
    "CRIMINAL"
  ],
  "extFirstName": "JOHN",
  "extLastName": "DOE",
  "extDob": "1996-07-01",
  "extStreetNumber": "123",
  "extStreetName": "EXAMPLE LANE",
  "extCity": "PERTH",
  "extPostCode": "6000",
  "extCountry": "AUSTRALIA",
  "docCountryISO": "AUS",
  "docExpiry": "2035-12-01",
  "sourceKey": "Example Source Key",
  "externalUserId": []
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://manual.personr.co/api-documentation/applicant-results/retrieving-applicant-verification-results/setting-up-a-webhook.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.