---
title: "Get all customers"
method: GET
path: "/customers"
tags: ["Customers"]
---

# Get all customers

`GET /customers`

Get the full list of all customers created on Bridge

## Query parameters

- `starting_after` string
- `ending_before` string
- `limit` integer
- `email` string

## Response `200`

List of customers (the returned list is empty if none found)

- object
  - `count` integer, required — total number of items in data
  - `data` Customer[], required
    - `id` string — A UUID that uniquely identifies a resource
    - `first_name` string
    - `last_name` string
    - `email` string
    - `status` 'active' | 'awaiting_questionnaire' | 'awaiting_ubo' | 'incomplete' | 'not_started' | 'offboarded' | 'paused' | 'rejected' | 'under_review' — `offboarded`: represents a customer's account that was internally reviewed and closed due to suspicious activity. `paused`: represents a customer's account that is currently under review because of activity on the platform.
    - `capabilities` object
      - `payin_crypto` 'pending' | 'active' | 'inactive' | 'rejected' — State of the customer capability
      - `payout_crypto` 'pending' | 'active' | 'inactive' | 'rejected' — State of the customer capability
      - `payin_fiat` 'pending' | 'active' | 'inactive' | 'rejected' — State of the customer capability
      - `payout_fiat` 'pending' | 'active' | 'inactive' | 'rejected' — State of the customer capability
    - `future_requirements_due` string[] — Information about requirements that may be needed in the future for the customer (eg. enhanced KYC checks for high volume transactions etc.). Please consult our KYC guide on how to resolve each requirement.
    - `requirements_due` string[] — KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement.
    - `created_at` string, date-time — Time of creation of the customer
    - `updated_at` string, date-time — Time of last update of the customer
    - `rejection_reasons` RejectionReason[] — Reasons why a customer KYC was rejected
      - `developer_reason` string — Developer information for why a customer was rejected. Not to be shared with the customer.
      - `reason` string — Reason for why a customer was rejected. To be shared with the customer.
      - `created_at` string, nullable — Time of creation of the rejection reason
    - `has_accepted_terms_of_service` boolean — Whether the customer has accepted the terms of service.
    - `client_reference_id` string — A client-provided reference ID that uniquely identifies a resource in the client's system
    - `endorsements` Endorsement[] — A summary of whether the customer has received approvals to complete onboarding or use certain products/services offered by Bridge.
      - `name` 'base' | 'cards' | 'cop' | 'faster_payments' | 'pix' | 'pix_onramp' | 'pix_offramp' | 'sepa' | 'spei', required — The type of endorsement. Note: `pix_onramp` (BRL deposits via PIX) and `pix_offramp` (BRL withdrawals via PIX) can be requested individually for granular access. Requesting `pix` grants both directional endorsements. `pix_onramp` is not supported for non-BR individuals; if requested (or requested via `pix`) it will remain in an `endorsement_not_available_in_customers_region` state and no action is required.
      - `status` 'incomplete' | 'approved' | 'revoked', required
      - `additional_requirements` EndorsementRequirementEnum[] — This field is deprecated. See endorsement.missing instead. Additional requirements that need to be completed for obtaining the approval for the endorsement. 1. `kyc_approval` and `tos_acceptance` are required for the `base` endorsement. 2. `tos_v2_acceptance` is required for `sepa`. If `tos_v2_acceptance` is not completed, a ToS acceptance link can be retrieved for the current customer from the endpoint `/v0/customers/{customerID}/tos_acceptance_link`. To fulfill the `kyc_with_proof_of_address` requirement, a KYC link can be specifically requested for the current customer via the endpoint `/v0/customers/{customerID}/kyc_link`, with `endorsement=sepa` included in the query string
      - `requirements` object — This object aims to replace the `additional_requirements` attribute as it gives a more comprehensive view into what items are already `complete` or `pending` and which are `missing` or have `issues`.
        - `complete` string[], required — an array of requirements that have already been completed for this endorsement.
        - `pending` string[], required — an array of requirements that are pending review for this endorsement.
        - `missing` object, required — an object that will specify an indepth breakdown of what items are missing for this endorsement.
        - `issues` union[], required — An array of issues preventing this endorsement from being approved. Values in this array can be either a string such as `endorsement_not_available_in_customers_region` or an object that correlates the issue to a particular field such as `{ id_front_photo: "id_expired" }`
          - union
            - string
            - object
      - `future_requirements` object[] — An array of upcoming requirements that will become active on their effective_date. Each entry has the same structure as the current requirements object, plus an effective_date indicating when the requirement takes effect.
        - `effective_date` string, date, required
        - `verification_stage` 'automatic_review' | 'manual_review' | 'post_review' | 'complete' | 'not_applicable', required — The verification stage this future requirement is currently at.
        - `pending` string[], required
        - `missing` object, nullable, required
        - `issues` union[], required
          - union
            - string
            - object

## Other responses

- `401` — Missing or invalid API key
- `500` — Unexpected error. User may try and send the request again.

---

[API](https://skmtc.net/bridge/apis/bridge-api.md) · [All operations](https://skmtc.net/bridge/apis/bridge-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bridge/bridge-api/revisions/570998bde3b5/schema)