Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Events sent by Ondato will have a body in the following structure:

Property

Description

Id

Webhook ID.

ApplicationId

Internal ID that identifies you in Ondato system.

CreatedUtc

Date and time when webhook was generated.

DeliveredUtc

Date and time when webhook was delivered.

IsDelivered

Status of the webhook if it was delivered or not. Possible values are true/ false.

Payload

Depending on the webhpook type property, the payload always returns the same information you could obtain from the GET endpoint of the recourse. E.g. of the webhook type is KycIdentification.<<event>> then payload will contain information you could retrieve from KYC ID endpoint GET /v1/identifications/{id} .

Type

Type of the webook. It contains of two parts:

  • Recourse, e.g. KycIdentification.

  • Event, e.g. Created.

...

Events
Anchor
Events
Events

You can configure the following events to trigger a message to registered webhooks:

Wehook event

Webhook is triggered when:

Webhook example link

Identity Verification (IDV) resource webhooks

IdentityVerification.Consented

User accepts consent agreement on new identification.

To view webhook example please click here.

IdentityVerification.StatusChanged

IDV status changes.

To view webhook example please click here.

KYC Identifiation recourse webhooks

KycIdentification.Created

KYC Identification step is started by the customer.

To view webhook example please click here.

KycIdentification.Processed

KYC Identification is completed by the customer.

To view webhook example please click here.

KycIdentification.Approved

KYC Identification identification is manually or automatically approved.

To view webhook example please click here.

KycIdentification.Updated

document data of KYC Identification is updated in Ondato Portal.

To view webhook example please click here.

KycIdentification.Rejected

KYC Identification is manually or automatically rejected.

To view webhook example please click here.

KYB Identification resource webhooks

KybIdentification.Created

Customer finished filling in business onboarding form.

To view webhook example please click here.

KybIdentification.Approved

All KYC identifications were approved and all registries checks were successfully validated.

To view webhook example please click here.

KybIdentification.Rejected

Not all KYC identifications were approved and/or not all registries were successfully validated.

To view webhook example please click here.

KybIdentification.Document.Created

KYB related document entity is created in the KYB identification with status “NeedReview”.

To view webhook example please click here.

KybIdentification.Document.Uploaded

KYB related document file is uploaded to the document entity.

To view webhook example please click here.

KybIdentification.Document.Updated

KYB related document is verified and status is changed from “NeedReview” to “Validated”/ “Invalidated”.

To view webhook example please click here.

KybIdentification.Document.Deleted

KYB related document is deleted from KYB identification.

To view webhook example please click here.

...