...
Identify the events you want to monitor. Please see a full list of events here.
Create a webhook endpoint as a HTTP endpoint on your local server.
Handle requests from Ondato.
Deploy your webhook endpoint so it would be publicly accessible HTTPS URL.
Register the publicly accessible HTTPS URL with Ondato by contacting Ondato support team.
...
Webhook events we are currently supporting:
...
Wehook event
...
Webhook is triggered when
...
Idv.Consented
...
user accepts consent agreement on new identification.
...
Idv.StatusChanged
...
Identity Verification status changes.
...
KycIdentification.Created
...
new identification is started by the customer.
...
KycIdentification.Processed
...
new identification is completed by the customer.
...
KycIdentification.Approved
...
identification is manually or automatically identified.
...
KycIdentification.Updated
...
document data is updated in Ondato Portal.
...
KycIdentification.Rejected
...
identification is manually or automatically unidentified.
...
KybIdentification.Created
...
customer finished filling in a form.
...
KybIdentification.Document.Created
...
KYB related document entity is created in the KYB identification with status “NeedReview”.
...
KybIdentification.Document.Uploaded
...
KYB related document file is uploaded to the document entity.
...
KybIdentification.Document.Updated
...
KYB related document is verified and status is changed from “NeedReview” to “Validated”/ “Invalidated”.
...
KybIdentification.Document.Deleted
...
KYB related document is deleted from KYB identification.
...
Create webhook endpoint
Ondato needs to know where to send information about events. In order to receive webhooks you need to create a webhook endpoint and provide us with the publicly accessible HTTPS URL that would meet the following criteria:
URL format: https://<your-website-name>/<your-webhook-endpoint>.
URL must support POST HTTP Method.
URL must support one of the available authentication flows that you self selected when configuring subscription.
3. Handle requests from Ondato
Your endpoint must be configured to support event notifications you want to receive. Each event Events sent by Ondato will have a body in the following contract:
| Code Block | ||
|---|---|---|
| ||
{
"id": "45a51829-965c-49ac-8fbb-940aa3d8486f",
"applicationId": "d73da14e-a6b9-4bb1-b9df-f3b40ba1ed34",
"createdUtc": "2022-07-26T07:16:41.873Z",
"payload": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationId": "d73da14e-a6b9-4bb1-b9df-f3b40ba1ed34",
"setup": {
"id": "56d0b462-6f88-4725-9a7a-578c58acd85a",
"versionId": "5c45f048-70f5-4f11-a623-b001087b78ac"
},
"createdUtc": "2022-07-26T07:16:40.873Z",
"identityVerificationId": "9eae922a-00af-4e54-830b-ca6f7fe5af16",
"status": "Unfinished"
},
"type": "Form.Created" |
Webhook events list
| Anchor | ||||
|---|---|---|---|---|
|
Webhook events we are currently supporting:
Wehook event | Webhook is triggered when |
|---|---|
| user accepts consent agreement on new identification. |
| Identity Verification status changes. |
| new identification is started by the customer. |
| new identification is completed by the customer. |
| identification is manually or automatically identified. |
| document data is updated in Ondato Portal. |
| identification is manually or automatically unidentified. |
| customer finished filling in a form. |
| KYB related document entity is created in the KYB identification with status “NeedReview”. |
| KYB related document file is uploaded to the document entity. |
| KYB related document is verified and status is changed from “NeedReview” to “Validated”/ “Invalidated”. |
| KYB related document is deleted from KYB identification. |