Skip to main content

Send KYC Invitation To User

POST 
/v1/kyc/invite
Required scopes
kyc.invite.write

EndPoint Description : Initiates the KYC onboarding flow by sending an invitation to an individual. The invite is created using the selected configuration and may include additional documents if required. Upon receiving the invite, the individual can begin completing KYC verification tasks.

Details :

  • A secure onboarding link is generated and sent to the individual's email address.
  • Optional hostedUIAppId: pass your white-labeled application id (Hosted UI id) so the invite link opens your branded application; omit for the default ChainIT onboarding experience.
  • The operation is scoped to the authenticated organization.

Request​

Responses​

Webhook Events

This API can trigger the following webhook events. Subscribe to them in the webhook event reference to receive real-time notifications.

KYC_VERIFIED
KYC Verified
Triggered when a user is invited by an organization, accepts the invitation, and successfully completes the required onboarding tasks on the platform. This webhook notifies your system about the completion of the user onboarding process and provides the verification status indicating whether the user has been successfully verified or not. It enables your application to update user access, assign roles and permissions, activate organization-level features, or initiate any downstream workflows that depend on a fully onboarded and verified user.
Full event reference