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

# List Remitters

> Lists your organization's remitters, with search, a residence-country filter and pagination.

<Prompt description="List Remitters" actions={["cursor"]}>
  Add the Zapyd "List Remitters" call (`GET /cms/api/v1/kyc/remitter/list`) to my backend. Lists your organization's remitters, with search, a residence-country filter and pagination.

  * Sandbox: `GET https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/list`
  * Production: `GET https://api.zapyd.com/cms/api/v1/kyc/remitter/list`

  Query parameters:

  * `search` (string, optional): Search text (min 3 characters).
  * `country` (string, optional): Residence country, ISO alpha-3.
  * `page` (integer, optional): Page number.
  * `per_page` (integer, optional): Results per page (10–100).

  Success: HTTP 200, `{status: true, message, data}`. `data`: `count`, `next`, `previous`, `results`.
  Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).

  Rules:

  * Paginated: `data` has `count`, `next`, `previous` and `results`, newest first. Use it to find a remitter you already created.

  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 `listRemitters` 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/remitter/list.md`
</Prompt>


## OpenAPI

````yaml GET /kyc/remitter/list
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/remitter/list:
    get:
      tags:
        - KYC
      description: >-
        List your organization's remitters, newest first, with pagination.
        `search` matches name, email, phone, client_reference_id or remitter id;
        `country` filters by residence country.
      parameters:
        - name: search
          in: query
          required: false
          description: Search text (min 3 characters)
          schema:
            type: string
          example: Siva
        - name: country
          in: query
          required: false
          description: Residence country, ISO alpha-3
          schema:
            type: string
          example: ARE
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          required: false
          description: Results per page (10–100)
          schema:
            type: integer
            minimum: 10
            maximum: 100
            default: 20
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Remitters fetched
                  data:
                    type: object
                    properties:
                      count:
                        type: integer
                        example: 1
                      next:
                        type:
                          - string
                          - 'null'
                        example: null
                      previous:
                        type:
                          - string
                          - 'null'
                        example: null
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                Remitter ID. Pass as remitter_id on remittance
                                payout requests.
                              example: e14fa86f-2a5e-437a-a031-949c68ade933
                              format: uuid
                            client_reference_id:
                              type:
                                - string
                                - 'null'
                              example: remitter-ref-001
                            first_name:
                              type: string
                              example: Siva
                            last_name:
                              type: string
                              example: Raj
                            full_name:
                              type: string
                              example: Siva Raj
                            email:
                              type:
                                - string
                                - 'null'
                              example: null
                            phone:
                              type: string
                              example: '+61412345678'
                            dob:
                              type: string
                              example: '1990-01-15'
                              format: date
                            nationality:
                              type: string
                              example: IND
                            residence_country:
                              type: string
                              example: ARE
                            city:
                              type: string
                              example: Sydney
                            address_line:
                              type: string
                              example: 1 George Street
                            source_of_funds:
                              type: string
                              example: salary
                            document_type:
                              type: string
                              description: Stored document type
                              example: PASSPORT
                            status:
                              type: string
                              description: >-
                                Remitter status. VERIFIED on create; the
                                remitter's identity is checked when the payout
                                is fulfilled.
                              example: VERIFIED
                              enum:
                                - UNVERIFIED
                                - PROCESSING
                                - VERIFIED
                                - FAILED
                                - MANUAL_REVIEW
                            created_at:
                              type: string
                              example: '2026-09-30T10:00:00+00:00'
                              format: date-time
        '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:
                      search:
                        - search must be at least 3 characters
                  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: 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.