> ## Documentation Index
> Fetch the complete documentation index at: https://docs.remitflex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List customers

> Requires `api:read` scope.



## OpenAPI

````yaml /openapi.yaml get /customers
openapi: 3.1.0
info:
  title: Remitflex API
  version: 1.0.0
  description: >
    Programmatic access to Remitflex payment routes, fiat rates, customers, and
    transactions.


    **Dashboard:** Create API keys at https://dashboard.remitflex.io


    **Authentication:** Send your API key as `Authorization: Bearer
    rmf_live_...` or `rmf_test_...`.


    **Idempotency:** Mutating requests (`POST`, `PUT`, `PATCH`, `DELETE`)
    require an `Idempotency-Key` header when authenticated with an API key.
servers:
  - url: http://localhost:4000/v1
    description: Local development
  - url: https://api.remitflex.io/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: Requires `api:read` scope.
      operationId: listCustomers
      responses:
        '200':
          $ref: '#/components/responses/ListCustomers'
      security:
        - ApiKeyAuth: []
components:
  responses:
    ListCustomers:
      description: Customers list
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/SuccessEnvelope'
              - type: object
                properties:
                  data:
                    type: object
                    properties:
                      customers:
                        type: array
                        items:
                          $ref: '#/components/schemas/Customer'
                      total:
                        type: integer
          examples:
            success:
              $ref: '#/components/examples/ListCustomersResponse'
  schemas:
    SuccessEnvelope:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          nullable: true
    Customer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
        type:
          type: string
        isPrimary:
          type: boolean
        cngn:
          type: object
          nullable: true
          description: >
            Present when cNGN enablement has been started or completed. `null`
            when the customer has never enabled cNGN. When `identityMatched` is
            not `true`, RemitFlex withholds StRails PII (legal name, VA, wallet)
            so a mismatched BVN cannot leak another person's identity to the
            merchant. Matching requires a multi-part name (first + last) with
            strong overlap to KYC / VA name.
          properties:
            enabled:
              type: boolean
              description: True only when linked and KYC name matches customer.name.
            identityMatched:
              type: boolean
              nullable: true
              description: >
                Whether the merchant customer name matches StRails KYC / VA
                name. `false` means BVN holder does not match this customer.
            status:
              type: string
              nullable: true
            legalName:
              type: string
              nullable: true
              description: StRails KYC name — only when identityMatched is not false.
            evmWallet:
              type: string
              nullable: true
            virtualAccount:
              type: object
              nullable: true
              properties:
                accountNumber:
                  type: string
                accountName:
                  type: string
                  nullable: true
                bankName:
                  type: string
                  nullable: true
                bankCode:
                  type: string
                  nullable: true
            syncedAt:
              type: string
              format: date-time
              nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  examples:
    ListCustomersResponse:
      value:
        status: success
        message: Customers fetched
        data:
          customers:
            - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
              name: Acme Ltd
              email: treasury@acme.io
              type: business
              isPrimary: true
              createdAt: '2026-06-01T00:00:00.000Z'
              updatedAt: '2026-06-01T00:00:00.000Z'
          total: 1
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >
        API key created in the Remitflex Dashboard at dashboard.remitflex.io
        (`rmf_live_...` or `rmf_test_...`).

        Key management endpoints require a dashboard JWT and are not part of
        this reference.

````