Partner API
  1. User & KYC Webhooks
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Get Balances
      • Get Transaction History
      • Retrieve Exchange Rate and Create a Lock
      • Create and Finalize an Exchange
      • Create Crypto Withdrawal
      • Create a SEPA Transfer
      • Get SEPA Transfer Details
    • User Accounts with KYC
      • Create User Account and Generate Balances
      • Add KYC File
      • Add POA File
      • Add User Verification
      • Update Existing User
      • Delete User
      • Suspend User
      • Unsuspend User
      • Get User Balances
      • Get User Transaction History
    • User Accounts without KYC
      • Create User Account and Generate Balances Without KYC
      • Update Existing User
      • Delete User
      • Suspend User
      • Unsuspend User
      • Get User Balances
      • Get User Transaction History
    • KYC by P100
      • Creating KYC Verification
      • Redirect to Verification
      • Get KYC Status
    • Currency Exchange
      • Retrieve Exchange Rate
      • Retrieve Exchange Rate and Create a Lock
      • Create and Finalize an Exchange
      • Retrieve Detailed Exchange Infromation
    • Crypto Deposits
      • Update Travel Rule
    • Crypto Withdrawals
      • Get Network Fee
      • Create Crypto Withdrawal
      • Get Crypto Withdrawal Details
    • Internal Transfers
      • Create a Transfer
      • Get Transfer Details
    • Virtual Cards
      • Create Virtual Card
      • Get All User Cards
      • Get Card Details
      • Update Card PIN
      • Block Card
      • Unblock Card
      • Get Card Limits
      • Update Card Limits
      • Delete Card
    • Custom Fiat Operations
      • SEPA Deposit & Withdrawal
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation
          POST
        • KYC File Added
          POST
        • POA Verification Status
          POST
        • KYC Verification Status
          POST
      • Transfers & Payments Webhooks
        • P2P Transfer Webhook
        • SEPA Transfer
        • SEPA Deposit
        • Crypto Withdrawal
        • Crypto Deposit
        • Exchange
        • Card Transaction
      • Card Webhooks
        • Card 3DS Code
        • Card Activation Code
  • Reference
    • Supported Countries
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. User & KYC Webhooks

KYC Verification Status

Webhook
POST
/webhook/kyc-verification/status
This event provides detailed, real-time updates on the Know Your Customer (KYC) verification process. It is triggered whenever there is a change in the user's overall verification status or the status of a specific verification attempt.
This webhook is critical for managing user access and providing accurate feedback, distinguishing between the permanent state of the user (verificationStatus) and the outcome of a single attempt (attemptStatus).

Status Descriptions (verificationStatus):#

This field represents the user's overall, persistent KYC status.
NOT_VERIFIED: The user has not yet completed or successfully passed the KYC process.
VERIFIED: The user has successfully passed KYC and is considered fully verified.
EXPIRED: The user's previous verification has expired, and they are required to complete the process again.

Status Descriptions (attemptStatus):#

This field describes the outcome of a single, specific verification attempt. It is optional and will only be present when an attempt is being processed.
PENDING: The verification attempt has been initiated and is awaiting processing.
VERIFICATION: The attempt is actively being processed by the verification provider.
REJECTED_BY_PROVIDER: The attempt was rejected by the provider. The rejectionReason field will contain specific details about the failure.
SUCCESSFUL: The attempt was successful. This typically results in the verificationStatus changing to VERIFIED.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data-raw '{
  "externalUserId": "bca65c48-df49-4831-a7b2-de7903321581",
  "verificationStatus": "NOT_VERIFIED",
  "attemptStatus": "REJECTED_BY_PROVIDER",
  "rejectionReason": "NO_FACE_FOUND"
}'
Response Response Example
{}

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Previous
POA Verification Status
Next
P2P Transfer Webhook
Built with