> ## 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.
# Add Payout KYC
> Creates the payout-only KYC profile for a beneficiary customer. The tax number is optional.
Add the Zapyd "Add Payout KYC" call (`POST /cms/api/v1/kyc/payout/add-kyc-data`) to my backend. Creates the payout-only KYC profile for a beneficiary customer. The tax number is optional.
* Sandbox: `POST https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data`
* Production: `POST https://api.zapyd.com/cms/api/v1/kyc/payout/add-kyc-data`
JSON body:
* `customer_id` (string, uuid, required): Customer from Create Payout Customer.
* `tax_number` (string, optional): Tax number, e.g. PAN for India. Example: `ABCDE1234F`.
Success: HTTP 200, `{status: true, message, data}`. `data`: `id`, `status`, `failure_reason`.
Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).
Rules:
* Payout-only onboarding, step 2: right after `POST /customer/payout/create`. Payout-only onboarding must be enabled for your organization and for the beneficiary's country.
* `tax_number` is optional and must not belong to another customer in your organization. Next: `POST /kyc/payout/add-sender-kyc-data`.
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 `addPayoutKyc` 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/payout-add-kyc-data.md`
Part of the payout-only onboarding flow. See the [payout-only onboarding guide](/guides/customers/payout-only-onboarding) for the order of calls and the fields each country requires.
## OpenAPI
````yaml POST /kyc/payout/add-kyc-data
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/payout/add-kyc-data:
post:
tags:
- KYC
description: >-
Create the payout-only KYC profile for a beneficiary customer.
tax_number (e.g. PAN) is optional here and must not belong to another
customer in your organization. Part of the payout-only onboarding flow;
see the [payout-only onboarding
guide](/guides/customers/payout-only-onboarding). Requires payout-only
onboarding to be enabled for your organization and the customer's
country.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: Customer from Create Payout Customer
example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
format: uuid
tax_number:
type: string
description: Tax number, e.g. PAN for India
example: ABCDE1234F
required:
- customer_id
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success
data:
type: object
properties:
id:
type: string
description: KYC profile ID
example: 550e8400-e29b-41d4-a716-446655440000
format: uuid
status:
type: string
description: KYC status
example: PROCESSING
failure_reason:
type:
- string
- 'null'
example: null
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Bad Request
data:
type: 'null'
errors:
type: object
example:
pan:
- >-
PAN is already linked to another customer within this
organization.
err_code:
type: string
example: UNKNOWN_ERROR
'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'
errors:
type: object
example: {}
err_code:
type: string
example: SYS_INTERNAL_ERROR
servers:
- url: https://sandbox.zapyd.com/cms/api/v1
description: Customer 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.