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

# List Remitters

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

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

  Endpoint: GET /kyc/remitter/list
  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): GET [https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/list](https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/list)

  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 optional search (min 3 characters), country (residence, alpha-3), page and per\_page
  2. Builds the signed auth headers (GET signs "{}"; query params are not signed)
  3. Calls GET /kyc/remitter/list with the filters as query parameters
  4. Returns data.count, data.next, data.previous and data.results (remitter objects)
  5. Handles 400 and 500 errors

  Language: TypeScript
</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: Zapyd runs
                                no KYC on a remitter; the payout partner checks
                                it during fulfillment.
                              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

````