Using KYC webhooks
Use the Webhook Integration when your clients have already been onboarded and you want to register their existing information with your organization.
Instead of asking users to complete the KYC process again, your system sends their existing customer details to the webhook. The webhook validates and registers the customer with Verified Network, ensuring clients records remain synchronized without requiring another onboarding flow.
Recommended use case:
Migrating existing customers to our platform.
Registering users who have already completed onboarding in your own system with Verified Network
Synchronizing users records between your platform and Verified Network.
Onboarding new users? See the KYC Plugin Guide
Prerequisites
Before the webhook integration can be enabled, the following setup is required:
You must provide a restricted, read-only Sumsub App Token with permission to retrieve individual applicant details only.
We will onboard your organization on our platform and provide you with a unique Organization ID.
Important: The Organization ID must be included in every webhook request. Requests submitted without a valid Organization ID will be rejected.
Contact Verified Team on Discord: https://discord.com/invite/N5xYeePjmt
Webhook Limitations
The webhook is designed only to register an existing user on our platform.
When a registration request is successful:
The user is registered on Verified Network with initial KYC status is set to 1 (Pending Approval).
The webhook cannot:
Verify or approve a user's KYC status on our platform.
Update or block a user's KYC status.
Perform any KYC management actions.
These operations are restricted to authorized KYC managers on our platform.
KYC Requirement Differences
A user may have successfully passed KYC within your platform but still not satisfy our platform's KYC requirements.
To handle these cases, an agreed communication process must be established before integration. Depending on the agreed workflow, we may:
Contact the user directly using the email address provided during registration, or
Notify your team so that you can communicate the additional requirements to the user.
This ensures any outstanding compliance requirements can be completed before the user's verification is finalized on our platform.
KYC Questionnaire
In addition to the applicant information submitted, users are also required to complete a KYC questionnaire.
The required questionnaire varies depending on the type of user being onboarded. The questionnaire requirements are described in the Know Your Customer (KYC) documentation.
During the integration phase, after your organization has been successfully configured on our platform, we will provide the list of questionnaire fields applicable to your organization user types. These fields should be included as additional data in your webhook requests.
This allows both the applicant information and questionnaire responses to be processed together during user registration.
Note: The KYC questionnaire schema is provided only after your organization has been successfully onboarded and configured on our platform.
Integration
Once your organization has been successfully configured on our webhook and we received read-only Sumsub token, we will provide:
Your Organization ID.
Webhook authentication details.
Sample code and integration snippets demonstrating how to submit existing customer details to the webhook.
Last updated