> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapyd.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Mock KYC Status [Sandbox Only]
> Sandbox only. Simulates KYC status changes so you can test your KYC flow.
Add the Zapyd "Mock KYC Status" call (`PATCH /cms/api/v1/kyc/mock-kyc-status`) to my backend. Sandbox only. Simulates KYC status changes so you can test your KYC flow.
* Sandbox: `PATCH https://sandbox.zapyd.com/cms/api/v1/kyc/mock-kyc-status`
* Production: none, sandbox only
JSON body:
* `customer_id` (string, uuid, required): Zapyd customer ID (UUID) returned by Create Customer.
* `kyc_status` (string, required): KYC result to set. The FAILED values map to the failure\_reason you get back. One of: `VERIFIED`, `UNVERIFIED`, `DOCUMENT_VERIFICATION_FAILED`, `TAX_VERIFICATION_FAILED`, `ADDITIONAL_INFO_VERIFICATION_FAILED`.
* `is_edd_required_payin` (boolean, optional): Set to true to make payin limits require EDD for this customer. Example: `false`.
* `is_edd_required_payout` (boolean, optional): Set to true to make payout limits require EDD for this customer. Example: `false`.
Success: HTTP 200, `{status: true, message, data}`. `data`: `id`, `status`, `failure_reason` (KYC failure reason when status is FAILED, otherwise null).
Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).
Rules:
* Sandbox only: it doesn't exist in production. Keep it behind a sandbox-only flag or in test code.
* Sends the same `CUSTOMER` webhook production would. The customer needs KYC data first (`POST /kyc/add-kyc-data`), except USA customers.
* Allowed moves: `PROCESSING` to any value; `VERIFIED` or `FAILED` only back to `UNVERIFIED`; nothing from `UNVERIFIED`.
* Set `is_edd_required_payin` or `is_edd_required_payout` to test the EDD branch of your limit checks.
Signing (every request):
* Headers: `X-API-KEY`, `X-TIMESTAMP` (Unix seconds, within 300 s of server time; generate per request) and `X-SIGNATURE`.
* `X-SIGNATURE` = Base64(HMAC-SHA256(key = API secret, message = apiKey + "|" + timestamp + "|" + canonicalBody)). Base64 of the raw digest, not hex.
* canonicalBody: the JSON body with keys sorted at every nesting level, no whitespace (separators `,` and `:`), and every non-ASCII character escaped as lowercase `\uXXXX` (Python `json.dumps(body, sort_keys=True, separators=(",", ":"))`). Requests with no body (GET, DELETE) sign `{}`. Query parameters are not signed.
* Send the exact canonicalBody string you signed as the request body, with `Content-Type: application/json`.
* Test vector: key `3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d`, secret `test-secret-do-not-use`, timestamp `1735689600`. Signing `{}` gives `6sCtVSRQjU9+2/af8gdwUAvY1l6Ii6ENcbRfanPkhY0=`. Body `{"customer_id":"78c99d71-f28f-47a9-8302-93b286efbe0e","amount":100.5,"currency":"INR","meta":{"note":"Café","b":2,"a":1}}` gives `l+DvQrzlKbsOSxSYOdWoWHEehcFRZfDJPKlLDkm2cSI=`.
Deliver:
1. A typed `mockKycStatus` function in this codebase's language and HTTP client. Reuse an existing Zapyd client and signer, or write one small shared client.
2. Config from `ZAPYD_API_KEY`, `ZAPYD_API_SECRET` and `ZAPYD_BASE_URL`. The secret stays on the server, never in a browser or app.
3. Return `data`. When `status` is false, throw an error with the HTTP status, `err_code`, `message` and `errors`. Don't show raw errors to end users.
4. Retry only 429 and 5xx: exponential backoff from 1 s, capped at 30 s, at most 5 attempts.
5. Amounts as strings. Types for every field above.
6. Tests: the signer against the test vector, and this call against sandbox.
Reference: `https://docs.zapyd.com/api-reference-exchange/endpoint/kyc/mock-kyc-status.md`
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.
## OpenAPI
````yaml PATCH /kyc/mock-kyc-status
openapi: 3.1.0
info:
title: Zapyd API
description: API for Zapyd - Customer, Payout, and Webhook services
license:
name: MIT
version: 1.0.0
servers:
- url: https://sandbox.zapyd.com/pos/api/v1
description: Payout API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
- url: https://sandbox.zapyd.com/cms/api/v1
description: Customer API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
security:
- ApiKeyAuth: []
TimestampAuth: []
SignatureAuth: []
tags:
- name: Customer
description: Customer related operations
x-displayName: Customer
x-traitTag: true
- name: Payout
description: Payout related operations
- name: Webhooks
description: Webhook related operations
- name: Widget
description: Hosted buy/sell widget session initialization
paths:
/kyc/mock-kyc-status:
patch:
tags:
- KYC
description: >-
Sandbox only. Sets a customer's KYC result and sends the CUSTOMER
webhook. The customer must already have KYC data (add-kyc-data), except
USA customers. A VERIFIED or FAILED customer can only be set back to
UNVERIFIED.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customer_id
- kyc_status
properties:
customer_id:
type: string
format: uuid
example: 4e6f1b20-a73c-11ec-b909-0242ac120002
description: Zapyd customer ID (UUID) returned by Create Customer.
kyc_status:
type: string
example: VERIFIED
description: >-
KYC result to set. The FAILED values map to the
failure_reason you get back.
enum:
- VERIFIED
- UNVERIFIED
- DOCUMENT_VERIFICATION_FAILED
- TAX_VERIFICATION_FAILED
- ADDITIONAL_INFO_VERIFICATION_FAILED
is_edd_required_payin:
type: boolean
description: >-
Optional. Set to true to make payin limits require EDD for
this customer.
example: false
is_edd_required_payout:
type: boolean
description: >-
Optional. Set to true to make payout limits require EDD for
this customer.
example: false
responses:
'200':
description: KYC Status updated successfully
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success
data:
type: object
properties:
id:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
status:
type: string
example: VERIFIED
failure_reason:
type:
- string
- 'null'
description: >-
KYC failure reason when status is FAILED, otherwise
null.
example: null
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Internal Server Error
data:
type: 'null'
err_code:
type: string
example: SYS_INTERNAL_ERROR
errors:
type: string
example: Unexpected error occurred. Please try again later.
servers:
- url: https://sandbox.zapyd.com/cms/api/v1
description: KYC API Base URL
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: API Key for authentication
TimestampAuth:
type: apiKey
in: header
name: X-TIMESTAMP
description: Current timestamp in seconds since epoch
SignatureAuth:
type: apiKey
in: header
name: X-SIGNATURE
description: HMAC SHA256 signature of the request encoded in Base64
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.