> ## 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.
# Update Payout KYC Details
> Updates documents, address or tax number on a payout-only KYC profile.
Integrate the Zapyd Update Payout KYC Details endpoint into my application.
Endpoint: PATCH /kyc/payout/update-additional-details
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): PATCH [https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details](https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details)
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 customer\_id or client\_reference\_id plus at least one of document\_type, document\_front\_image\_url, document\_back\_image\_url, full\_address, tax\_number (required for India)
2. Builds the signed auth headers
3. Calls PATCH /kyc/payout/update-additional-details
4. Returns the KYC profile id and status
5. Handles 400 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 PATCH /kyc/payout/update-additional-details
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/update-additional-details:
patch:
tags:
- KYC
description: >-
Update the payout-only KYC profile. Identify the customer by customer_id
or client_reference_id (if both are sent they must match). Send at least
one of document_type, document_front_image_url, document_back_image_url,
full_address or tax_number. tax_number is required for India. 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:
customer_id:
type: string
description: Customer ID
example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
format: uuid
client_reference_id:
type: string
description: Alternative to customer_id
example: beneficiary-001
alpha_3_country_code:
type: string
description: Must match the customer's country if sent
example: IND
document_type:
type: string
description: Identity document type
example: ONLY_PAN
enum:
- ONLY_PAN
- GOVT_ID
- PASSPORT
document_front_image_url:
type: string
example: https://example.com/front.jpg
format: uri
description: Optional. Front image URL of the document.
document_back_image_url:
type: string
example: https://example.com/back.jpg
format: uri
description: Optional. Back image URL of the document.
full_address:
type: string
description: Full address
example: 12 MG Road, Bengaluru
tax_number:
type: string
description: Tax number. Required for IND.
example: ABCDE1234F
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:
tax_number:
- This field is required for India (IND).
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
````