> For the complete documentation index, see [llms.txt](https://cartoonmango-1.gitbook.io/vida-ekyc-integration/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cartoonmango-1.gitbook.io/vida-ekyc-integration/integration-methods/api/ocr/webhooks.md).

# Webhooks

The Webhook is a way for VIDA to notify partners about updates on identity verification transactions. When a webhook is configured, VIDA will send notifications to the partner's API containing the status of the verification process and other relevant information, such as the unique transaction ID (kycEventId) and the partner's own transaction ID partnerTrxId (if provided in the API request). This allows partners to easily track the status of their user's identity verification requests. To receive webhook notifications, the partner's API should be able to accept JSON requests, and should be configured to accept the webhook URL, authentication method, and authentication credentials provided by VIDA. VIDA supports OAuth2-based "client credentials" and "Basic Auth" methods for authentication. The partner must share their preferred method of authentication along with the necessary credentials and URL to receive the webhook notifications.

## Weebhook Configuration

**Path variables**

No path variables are required for webhook.

**Headers**

Send the following parameters in the API header and API authorization section.

| Section       | Key          | Value                                                      | Description                                                                            |
| ------------- | ------------ | ---------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| Authorization | <p><br></p>  | <p>Example:</p><p>Bearer token</p><p>(eyJhbGciOSUzI1…)</p> | <p>OAuth access token. </p><p>Get the token by calling the ‘Get access token’ API.</p> |
| Headers       | Content-Type | application/JSON                                           | Format type of request body                                                            |

#### Response Status Codes

The [status check failure reasons](/vida-ekyc-integration/getting-started/status-check.md#status-check-failures-and-recommendation) table covers all the possible response status code along with the description and recommendation in case of failure. <br>
