KYC Events
Events related to Know Your Customer (KYC) verification processes. These events notify merchants about changes in the KYC verification level of their users and the results of individual identity verification sessions.Understanding KYC vs KYC Session
- KYC: Represents the overall verification level of a user (REGULAR or LIGHT KYC)
- KYC Session: Represents an individual verification attempt/process with specific checks
KYC Levels
The overall verification level of a user in the system:| Level | Code | Description |
|---|---|---|
| REGULAR | 1 | Full KYC verification completed |
| LIGHT | 2 | Basic/Light KYC verification |
KYC Session States
States of an individual verification session:| State | Code | Description |
|---|---|---|
| NOT_STARTED | 1 | Session created but verification not started |
| STARTED | 2 | Verification process in progress |
| VERIFIED | 3 | Session successfully verified |
| REVIEW | 4 | Session requires manual review by compliance staff |
| REJECTED | 5 | Session verification failed/rejected |
| EXPIRED | 6 | Session expired before completion |
KYC Session Check States
States of individual verification checks within a session (e.g., document verification, biometric verification):| State | Code | Description |
|---|---|---|
| Validated | 1 | Check passed successfully |
| Refused | 2 | Check failed or was refused |
Available Events
| Event | Description | Triggered By |
|---|---|---|
| kyc_state_updated | Notifies when the KYC level changes (LIGHT ↔ REGULAR) | KYC Level Change |
| kyc_session_verified | Notifies when a verification session is successfully verified | Session State: VERIFIED |
| kyc_session_manual_review | Notifies when a session requires manual review | Session State: REVIEW |
| kyc_session_failed | Notifies when a verification session fails | Session State: REJECTED |
| kyc_session_expired | Notifies when a verification session expires | Session State: EXPIRED |