π KYC Events
KYC events are notifications sent to partners when there are updates or changes in the user's identity verification process. These notifications help partners stay informed about the status of their users' verification and take appropriate actions in their systems.
Types of KYC Events
CREATED_KYC
(Created KYC):- Description: This event is triggered when a user has successfully uploaded all the information on our provider and the KYC has been created.
- Example Payload:
{ "type": "KYC", "event": "CREATED_KYC", "externalUserId": "61561e29-cb8f-475a-b913-7d70430badfe", }
VERIFIED_USER
(Verified User):- Description: This event is triggered when a user has successfully completed the KYC process and has been verified.
- Use Case: The partner can update their system to mark the user as verified, allowing the user to access certain features or services that require a verified status.
- Example Payload:
{ "type": "KYC", "event": "VERIFIED_USER", "externalUserId": "61561e29-cb8f-475a-b913-7d70430badfe", }
REJECTED_KYC
(KYC Rejected):- Description: This event is triggered when a user's KYC process has been completed, but the user has been rejected due to failing the verification checks (e.g., invalid documents, mismatched information).
- Use Case: The partner may notify the user that their verification has failed and guide them on the next steps to retry or provide additional information.
- Example Payload:
{ "type": "KYC", "event": "REJECTED_KYC", "externalUserId": "61561e29-cb8f-475a-b913-7d70430badfe", }
REVIEW_NEEDED_KYC
(Review Needed KYC):- Description: This event is triggered when the KYC verification process is incomplete, and additional review or manual intervention is needed.
- Use Case: Capa compliance team might need to manually review certain documents or data provided by the user to complete the verification process.
- Example Payload:
{ "type": "KYC", "event": "REVIEW_NEEDED_KYC", "externalUserId": "61561e29-cb8f-475a-b913-7d70430badfe", }
Summary of KYC Events
These KYC events help partners automate their response to changes in user verification status:
VERIFIED_USER
: Confirms that a user has been successfully verified.REJECTED_KYC
: Alerts the partner that a userβs verification has failed.REVIEW_NEEDED_KYC
: Indicates that additional action is needed to complete the verification process.
By processing these events, partners can ensure that their systems are up-to-date with the latest user verification statuses and can take appropriate actions to maintain compliance and provide the correct level of access to their users.
Updated 3 months ago