> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt
> Use this file to discover all available pages before exploring further.
# Add Payout Sender KYC
> Submits the beneficiary address and country-specific identity fields the payout partner requires.
Integrate the Zapyd Add Payout Sender KYC endpoint into my application.
Endpoint: POST /kyc/payout/add-sender-kyc-data
Base URL: [https://sandbox.zapyd.com/cms/api/v1](https://sandbox.zapyd.com/cms/api/v1) (sandbox) | [https://api.zapyd.com/cms/api/v1](https://api.zapyd.com/cms/api/v1) (production)
Full URL (sandbox): POST [https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-sender-kyc-data](https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-sender-kyc-data)
Auth headers required on every request:
* X-API-KEY: your API key
* X-TIMESTAMP: current Unix time in seconds
* X-SIGNATURE: Base64(HMAC-SHA256(key=apiSecret, data=X-API-KEY + "|" + X-TIMESTAMP + "|" + canonicalBody))
canonicalBody = request JSON with keys sorted at every nesting level, no whitespace (separators "," and ":"), non-ASCII escaped as lowercase \uXXXX. GET requests always sign "{}" (query params are not signed). Send the exact canonicalBody string as the request body. Timestamp must be within 300s of server time.
Task: Write a typed function that:
1. Accepts client\_reference\_id, country\_code, address fields (street, city, state\_province, postal\_code as the country requires), document fields and beneficiary\_identifiers
2. Builds the signed auth headers
3. Calls POST /kyc/payout/add-sender-kyc-data
4. Returns the record id and client\_reference\_id
5. Handles 400 (missing country address fields, country mismatch) and 500 errors
Language: TypeScript
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-sender-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-sender-kyc-data:
post:
tags:
- KYC
description: >-
Submit the address and identity details the payout partner needs for the
beneficiary. Address fields required depend on the country (see the
guide). beneficiary_identifiers carries country-specific extra fields,
for example beneficiary_id_doc_number and beneficiary_phone_number for
Colombia, or beneficiary_id_doc_number and beneficiary_dob (YYYY-MM-DD)
for Mexico. Call this before Add Payout Bank Account, with the same
client_reference_id. Part of the payout-only onboarding flow; see the
[payout-only onboarding
guide](/api-reference-exchange/integration-guides/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:
client_reference_id:
type: string
description: The beneficiary's client_reference_id
example: beneficiary-001
country_code:
type: string
description: >-
Beneficiary country, alpha-3. Must match the customer's
country if sent.
example: BRA
tax_number:
type: string
description: Tax number
example: '12345678909'
document_type:
type: string
description: Identity document type
example: PASSPORT
enum:
- ONLY_PAN
- GOVT_ID
- PASSPORT
document_front_image_url:
type: string
description: Document front image URL
example: https://example.com/front.jpg
format: uri
document_back_image_url:
type: string
description: Document back image URL
example: https://example.com/back.jpg
format: uri
street:
type: string
description: Street address
example: Av. Paulista 1000
city:
type: string
description: City
example: São Paulo
state_province:
type: string
description: State or province
example: SP
postal_code:
type: string
description: Postal code
example: 01310-100
beneficiary_identifiers:
type: object
description: Country-specific beneficiary fields
example: {}
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: Record ID
example: 7a1c0e7e-2b53-4f7e-9d2f-6d6e2b1c9a10
format: uuid
client_reference_id:
type: string
description: ''
example: beneficiary-001
'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:
postal_code:
- This field is required for BRA.
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
````