Submit KYC With Token
This API enables merchants to verify a contact’s identity seamlessly using Sumsub KYC solution. Instead of requiring contacts to upload identification documents and selfies directly, this API leverages a token-based approach.
When a contact completes their KYC process through Sumsub interface, a unique verification token is generated. This token represents the validated identity data, eliminating the need for manual document handling. The merchant submits this token along with the contact’s email to finalize the verification process on the server.
Additionally, this API allows for automated KYC status tracking through webhook notifications. Merchants can provide a callback URL and an authorization header to receive real-time updates whenever the KYC status changes, ensuring a smooth verification experience without requiring periodic checks.
With this approach, merchants can enhance security, streamline identity verification, and provide contacts with a frictionless onboarding experience.
Authorizations
A unique identifier assigned to each application.
A secure token associated with the app-id.
Body
The contact's email used for verification.
Usage Notes:
- You must call the Generate share token using Sumsub API first to obtain this token.
- This token is a unique identifier linking the contact to their KYC verification process.
- It is a required field and must be a valid token provided by Sumsub.
- The token is time-sensitive and may expire after a certain period if the KYC process is not completed.
- If the token is invalid or expired, the API will return an error.
Merchant Callback Details
Callbacks
POST{$request.body#/endpoint_url}KYCStatusChanged
Body
Contact's email
Contact's first name
Contact's last name
The type of contact (e.g., individual or organization)
individual, organization "individual"
Contact date of birth format 'yyyy-mm-dd'
Contact's phone
"+61-412345678"
Contact registration number.
Contact's gender
male, female "male"
The primary name of an address's street.
Name of an address's city or town.
The address's postcode
The address's state / province / county.
ISO 3166-1 alpha-2 country code.
Contains the most recent KYC submission details for the contact.
An array of KYC statuses for the contact, containing multiple KYC instances with status and message.
Response
The merchant's server should return this code
Response
KYC submission successful