Versions Compared

Version Old Version 11 New Version 12
Changes made by

Jurgita Krukonyte

Jurgita Krukonyte

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

About webhooks

Webhooks enable Ondato to send you real-time notifications about events happening with your Identity Verifications. changes in the status if your recourses. These are POST requests to your server that are sent as soon as event occurs. The body of the request contains resource information.

Security

Ondato uses HTTPS to send these notifications as a JSON payload.

Ordering

Ondato deliver events asynchronically.

...

Therefore, you might receive them out of order and handle them accordingly.

How to start receiving webhooks

To start receiving event notifications into your application you need to go through the following steps:

  1. Identify the events you want to monitor. Please see a full list of events here in a table below.

  2. Create a webhook endpoint as a an HTTP endpoint on your local server.

  3. Handle requests from Ondato.

  4. Deploy your webhook endpoint so it would be publicly accessible HTTPS URL.

  5. Register the publicly accessible HTTPS URL with Ondato by contacting Ondato support team.

...

Code Block
languagejson
{
	"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
Events
Events

Webhook events we are currently supporting:

Wehook event

Webhook is triggered when;

Identity Verification (IDV) resource webhooks

Idv.Consented

user accepts consent agreement on new identification.

Idv.StatusChanged

IDV status changes.

KYC Identifiation recourse webhooks

KycIdentification.Created

KYC Identification step is started by the customer.

KycIdentification.Processed

KYC Identification is completed by the customer.

KycIdentification.Approved

KYC Identification identification is manually or automatically approved.

KycIdentification.Updated

document data of KYC Identification is updated in Ondato Portal.

KycIdentification.Rejected

KYC Identification is manually or automatically rejected.

KYB Identification resource webhooks

KybIdentification.Created

customer Customer finished filling in a business onboarding 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.

...