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

> Completes the reduced KYC for a remittance beneficiary (an Indian or Chinese customer). The tax number (PAN) is optional.

<Prompt description="Add KYC Data" actions={["cursor"]}>
  Add the Zapyd "Add KYC Data" call (`POST /cms/api/v1/kyc/remittance-beneficiary-kyc`) to my backend. Completes the reduced KYC for a remittance beneficiary (an Indian or Chinese customer). The tax number (PAN) is optional.

  * Sandbox: `POST https://sandbox.zapyd.com/cms/api/v1/kyc/remittance-beneficiary-kyc`
  * Production: `POST https://api.zapyd.com/cms/api/v1/kyc/remittance-beneficiary-kyc`

  JSON body:

  * `customer_id` (string, uuid, required): The unique identifier of the customer.
  * `tax_number` (string, optional): Beneficiary tax number, e.g. PAN for India. Optional. Example: `HCDPS3890E`.

  Success: HTTP 200, `{status: true, message, data}`. `data`: `id` (Unique identifier of the KYC record), `customer_id`.
  Errors (`{status: false, message, err_code, errors}`):

  * 400 `Bad Request`: `customer_id` is missing
  * 400 `Customer not found`: Customer does not exist in your organization
  * 400 `This endpoint is restricted to Indian and Chinese customers only`: Customer country is not `IND` or `CHN`
  * 500 `Internal Server Error`
    Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).

  Rules:

  * India remittance (RDA) flow, step 2: after `POST /customer/create` with `alpha_3_country_code: IND`, before `POST /bank/create`. It replaces full document KYC for the beneficiary.
  * Full flow: create the beneficiary, run this call, add an `ACCOUNT_DETAILS` bank account (UPI isn't supported for remittance), create the remitter with `POST /kyc/remitter/create`, then `POST /pos/api/v1/remittance-payout/quotation` and `/initiate`.

  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 `addRemittanceBeneficiaryKyc` 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/remittance-beneficiary-kyc.md`
</Prompt>

## Error Codes and Messages

| API Status Code | Response | Reason |
| - | - | - |
| 400 | Bad Request | `customer_id` is missing |
| 400 | Customer not found. | Customer does not exist in your organization |
| 400 | This endpoint is restricted to Indian and Chinese customers only. | Customer country is not `IND` or `CHN` |
| 500 | Internal Server Error | Internal Server Error |


## OpenAPI

````yaml POST /kyc/remittance-beneficiary-kyc
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/remittance-beneficiary-kyc:
    post:
      tags:
        - KYC
      description: >-
        Completes the lightweight KYC required for the beneficiary (receiving
        customer) of a remittance payout. The customer must be from India (IND)
        or China (CHN). `tax_number` (for India, the PAN) is optional. Run this
        after creating the customer and before adding their bank account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - customer_id
              properties:
                customer_id:
                  type: string
                  format: uuid
                  description: The unique identifier of the customer
                  example: 638d9a52-9427-460e-99ba-948d46ce349c
                tax_number:
                  type: string
                  description: Beneficiary tax number, e.g. PAN for India. Optional.
                  example: HCDPS3890E
      responses:
        '200':
          description: Remittance sender KYC recorded 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
                        description: Unique identifier of the KYC record
                        example: ea6899a3-abb9-4418-8878-e23f5021e38f
                      customer_id:
                        type: string
                        format: uuid
                        example: 638d9a52-9427-460e-99ba-948d46ce349c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Bad Request
                  error:
                    type: object
                    example:
                      tax_number:
                        - This field is required.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
      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.