Verification And KYC API
Personal verification controls wallet limits, withdrawals, cards, crypto, merchant access, and cross-border features. Merchants should expect KYC-driven rejection or review errors when a user is not eligible.
Endpoints
| Endpoint | Method | Auth | Headers | Notes |
|---|---|---|---|---|
Start verification session/profiles/api/v1/verification/session/Route the user into the configured KYC provider session for the requested tier. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Compliance summary/profiles/api/v1/compliance/summary/Return current KYC tier, KYC status, risk state, and trusted-device signals for the signed-in user. |
GET | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
List policy documents/profiles/api/v1/compliance/policies/Return policy and consent documents relevant to the user country and language. |
GET | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Accept policy document/profiles/api/v1/compliance/policies/{document_id}/accept/Record acceptance of a policy document or regulated product agreement. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |
Eligibility check/profiles/api/v1/eligibility/check/Evaluate whether a user can access a product in a country and currency. |
POST | User JWT Authenticated caller |
Authorization: Bearer <user-jwt>Content-Type: application/json |
Sandbox: Supported with sandbox keys and adapters. Production: Available subject to verification, country activation, and provider support. Rate limits: Standard authenticated rate limits |