> ## 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 KYC

> Creates the payout-only KYC profile for a beneficiary customer; tax_number is optional.

<Prompt description="Add Payout KYC" actions={["cursor"]}>
  Integrate the Zapyd Add Payout KYC endpoint into my application.

  Endpoint: POST /kyc/payout/add-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-kyc-data](https://sandbox.zapyd.com/cms/api/v1/kyc/payout/add-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 customer\_id and optional tax\_number
  2. Builds the signed auth headers
  3. Calls POST /kyc/payout/add-kyc-data
  4. Returns the KYC profile id and status
  5. Handles 400 (tax number already used by another customer, unsupported country) and 500 errors

  Language: TypeScript
</Prompt>

<Note>
  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.
</Note>


## 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](/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 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

````