Initiate user verification (KYC/KYB) - Legacy

Note: This endpoint is for manual verification (legacy flow). The recommended approach is to provide all required fields during user creation, which triggers automatic verification.

Initiates KYC (Know Your Customer) verification for individual users or KYB (Know Your Business) verification for business users.

Two verification methods available:

  1. embedded-link: Generates a verification link where users complete KYC through a hosted interface

    • Simpler integration
    • User provides information directly through verification provider
    • Optional redirect URI after completion
  2. api: Programmatic verification where you submit all user data via API

    • Full control over UX
    • Supports both individual and business verifications
    • Requires collecting and submitting all verification data

Requires an idempotency key to prevent duplicate verification requests.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the user to verify

Body Params
string
enum
required

Verification method type

Allowed:
uri

Optional URL to redirect user after verification completion

Headers
uuid
required

Unique key to ensure idempotent requests

Responses

400

Bad request - validation error

401

Unauthorized

404

User not found

409

Conflict - idempotency key already used

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json