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

# List customers (connected accounts + payers)

> List the caller org + mode's unified customer directory: the connected accounts you onboarded unioned with the self-signup payers (buyers) you have billed. A payer that is also an onboarded account appears once, as the connected account. Filter by `kind` to return only one source. Payers are never invoice-able. Read-only; `nextCursor` is null in this version.



## OpenAPI

````yaml https://api.caratuva.com/docs-json get /v1/customers
openapi: 3.0.0
info:
  title: Caratuva API
  description: >-
    Cross-border B2B payments. Fiat on-ramp → USDC → PIX off-ramp.


    Every request runs in **test** or **live** mode on this single host — there
    is no separate sandbox URL. API keys carry the mode in their prefix
    (`pk_test_…` / `pk_live_…`); dashboard JWTs start in test and re-mint via
    `POST /v1/auth/switch-mode`. Test mode runs the full pipeline against a
    sandbox payment instance (KYB/KYC auto-approve, no real money); live runs on
    real rails and requires approved KYB. Test and live data are fully isolated.
    Check readiness with `GET /v1/onboarding/status`.
  version: 1.0.0
  contact: {}
servers: []
security: []
tags:
  - name: Invoices
    description: Create and manage invoices that collect for one of your sellers.
  - name: Payments
    description: Create a payment (keep your own checkout), fetch it, or cancel it.
  - name: Accounts
    description: >-
      Onboard and manage your sellers, buyers, and your own (self) account at
      the settlement partner.
  - name: Webhooks
    description: Subscribe to outbound event notifications and manage signing secrets.
  - name: API keys
    description: Issue, list, and revoke the API keys that authenticate your integration.
  - name: Access
    description: Request and check production (live-mode) access for your organization.
  - name: Reports
    description: Pull settlement and transfer-pricing reports.
paths:
  /v1/customers:
    get:
      tags:
        - Accounts
      summary: List customers (connected accounts + payers)
      description: >-
        List the caller org + mode's unified customer directory: the connected
        accounts you onboarded unioned with the self-signup payers (buyers) you
        have billed. A payer that is also an onboarded account appears once, as
        the connected account. Filter by `kind` to return only one source.
        Payers are never invoice-able. Read-only; `nextCursor` is null in this
        version.
      operationId: CustomersController_list
      parameters:
        - name: limit
          required: false
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          required: false
          in: query
          schema: {}
        - name: kind
          required: false
          in: query
          schema:
            enum:
              - connected_account
              - buyer
            type: string
      responses:
        '200':
          description: Unified customer directory for the caller org + mode
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        kind:
                          enum:
                            - connected_account
                            - buyer
                          type: string
                        id:
                          type: string
                        name:
                          type: string
                          nullable: true
                        email:
                          type: string
                          nullable: true
                        entityType:
                          type: string
                          enum:
                            - individual
                            - business
                        country:
                          type: string
                          nullable: true
                        status:
                          type: string
                        invoiceable:
                          type: boolean
                        externalId:
                          type: string
                          nullable: true
                        receiverId:
                          type: string
                          nullable: true
                        source:
                          type: string
                          enum:
                            - onboarded
                            - self_signup
                      required:
                        - kind
                        - id
                        - name
                        - email
                        - entityType
                        - country
                        - status
                        - invoiceable
                        - externalId
                        - receiverId
                        - source
                      additionalProperties: false
                  nextCursor:
                    type: string
                    nullable: true
                required:
                  - data
                  - nextCursor
                additionalProperties: false
              examples:
                default:
                  value:
                    data:
                      - kind: connected_account
                        id: ckacc042
                        name: Fazenda Boa Vista
                        email: finance@fazendaboavista.com.br
                        entityType: business
                        country: BR
                        status: approved
                        invoiceable: true
                        externalId: merchant-42
                        receiverId: rc_8a3f2b91
                        source: onboarded
                    nextCursor: null
      security:
        - apiKey: []
        - bearer: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````