Skip to main content
PATCH
cURL

Mock KYC Status [Sandbox Only]

This endpoint is available only in the Sandbox environment and allows you to simulate KYC status changes for testing purposes.This endpoint follows specific state transition rules:
  • If current status is UNVERIFIED: No status changes are allowed
  • If current status is FAILED or VERIFIED: Can only be changed to UNVERIFIED
  • If current status is PROCESSING: Can be changed to TAX_VERIFICATION_FAILED, DOCUMENT_VERIFICATION_FAILED, VERIFIED, or UNVERIFIED
Attempting to change the status outside of these allowed transitions will result in an error.

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
customer_id
string<uuid>
required
Example:

"4e6f1b20-a73c-11ec-b909-0242ac120002"

kyc_status
string
required
Example:

"VERIFIED"

Response

KYC Status updated successfully

status
boolean
Example:

true

message
string
Example:

"Success"

data
object