Business onboarding with KYB and KYC UI

Table of Contents

Introduction

This documentation will guide you through the business onboarding process with a partial Ondato APIs integration.

Workflow

Getting started

Please find details about authentication and setups in the following page: Getting started.

Webhooks

Ondato provides webhooks to alert you of changes with the identification. These are POST requests to your server that are sent as soon as an event occurs. The body of the requests will contain details of the resource. Webhooks are sent asynchronously and the actual order of webhooks can be determined by the property CreatedUtc.

In order to subscribe to the business onboarding webhooks service you must provide us with an HTTPS URL and authentication details. These details can be basic (user name, password) or oAuth2 (authentication token). One subscription can contain a single HTTPS URL and multiple webhook types. Multiple subscriptions can be created.

Swagger

You will need to use the following API for the integration:

• Ondato IDV API to initiate the business onboarding flow.

Integration steps

Initiate business onboarding

To initiate business onboarding you need to make POST request to IDV API resource /v1/identity-verifications with setupId in the request body.

Response with status code 201 will return id of identity verification that can be used to generate KYB form URL.

Generate business onboarding form (KYB) URL

After you receive identity verification id, you can generate a url and redirect your user to it for filling in the business onboarding details.

• The url must be in the following format: "https://idv.ondato.com/?id={id}”.

  • Example: https://idv.ondato.com/?id=02c99769-51a5-4174-aa5b-3fa0c2e6bfef

Webhooks

Following webhooks will be sent out while your user progresses with the business onboarding form:

• KybIdentification.Created - sent once your user finishes filling in the form. This webhook will contain payload information from the KYB identifications API resource GET /v1/identifications/{id}.

• IdentityVerification.StatusChanged - sent every time the status of the identity verification changes. This will inform you on the progress of filling in the form. Webhook will contain payload information from the IDV API resource GET /v1/identity-verifications/{id}.

  • Possible statuses of the Identity Verification:

    • Pending - the client created the user session.

    • In progress - the user started the session.

    • Completed - the user completed the flow and the session ended successfully.

    • Aborted - the user aborted the session (if the continue later feature was used, the user can still resume the session).

    • Expired - the user did not finish the session, and as a result, the session expired due to the timeout.

Track business onboarding form validation progress

Once KYC identifications of all representatives are complete, the rest of the KYB identification flow actions are performed on Ondato side. You will be informed of the progress.

KYB files webhooks

For the files uploaded by the user in the OS, you will receive the following webhooks:

• KybIdentification.Document.Created

  • The webhook is triggered when a KYB-related document entity is created in the KYB identification with the status "NeedReview."

• KybIdentification.Document.Uploaded

  • The webhook is triggered when a KYB-related document file is uploaded to the document entity.

• KybIdentification.Document.Updated

  • The webhook is triggered when a KYB-related document is verified, and the status changes from "NeedReview" to "Validated" or "Invalidated".

• KybIdentification.Document.Deleted

  • The webhook is triggered when a KYB-related document is deleted from KYB identification.

Webhooks above will contain payload information from the KYB Identification API resource GET/v1/documents/{id}.

It also applies to the registry documents added as files through the same feature (OS).

KYB identification approved / rejected webhooks

Once all KYC identifications are completed - the whole KYB identification is verified. Webhooks that you will receive:

• KybIdentification.Approved

  • The webhook is triggered when all KYC identifications have been approved and all registry checks have been successfully validated.

• KybIdentification.Rejected

  • The webhook is triggered when not all KYC identifications have been approved and/or when not all registries have been successfully validated.

Webhooks above will contain payload information from the KYB Identification API resource GET /v1/identifications/{id}.