Sandbox
Mock KYC Status [Sandbox Only]
Sandbox only. Simulates KYC status changes so you can test your KYC flow.
PATCH
cURL
Mock KYC Status
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
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
Zapyd customer ID (UUID) returned by Create Customer.
Example:
"4e6f1b20-a73c-11ec-b909-0242ac120002"
KYC result to set. The FAILED values map to the failure_reason you get back.
Available options:
VERIFIED, UNVERIFIED, DOCUMENT_VERIFICATION_FAILED, TAX_VERIFICATION_FAILED, ADDITIONAL_INFO_VERIFICATION_FAILED Example:
"VERIFIED"
Optional. Set to true to make payin limits require EDD for this customer.
Example:
false
Optional. Set to true to make payout limits require EDD for this customer.
Example:
false