Get all customers

get https://api.bridge.xyz/v0/customers

Get the full list of all customers created on Bridge

Query Params

starting_after

string

This is a customer id. If this is specified, the next page that starts with a customer right AFTER the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers older than the specified customer id will be returned (shouldn't be set if ending_before is set)

ending_before

string

This is a customer id. If this is specified, the previous page that ends with a customer right BEFORE the specified customer id on the customer timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that customers newer than the specified customer id will be returned (shouldn't be set if starting_after is set)

limit

integer

The number of items to return (default of 10, max of 100)

Responses

Response body

object

count

integer

required

total number of items in data

data

array of objects

required

length ≥ 0

data*

object

string

length between 1 and 42

A UUID that uniquely identifies a resource

first_name

string

length between 1 and 1024

last_name

string

length between 1 and 1024

string

length between 1 and 1024

status

string

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.

active awaiting_questionnaire awaiting_ubo incomplete not_started offboarded paused rejected under_review

capabilities

object

future_requirements_due

array of strings

length ≥ 0

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.

future_requirements_due

requirements_due

array of strings

length ≥ 0

KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement.

requirements_due

created_at

date-time

Time of creation of the customer

updated_at

date-time

Time of last update of the customer

rejection_reasons

array of objects

length ≥ 0

Reasons why a customer KYC was rejected

rejection_reasons

object

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

Time of creation of the rejection reason

has_accepted_terms_of_service

boolean

Whether the customer has accepted the terms of service.

endorsements

array of objects

length ≥ 0

A summary of whether the customer has received approvals to complete onboarding or use certain products/services offered by Bridge.

endorsements

object

name

string

required

The endorsement type.

base sepa spei

status

string

required

incomplete approved revoked

additional_requirements

array of strings

length ≥ 0

Additional requirements that need to be completed for obtaining the approval for the endorsement.

kyc_approval and tos_acceptance are required for the base endorsement.
kyc_with_proof_of_address and tos_v2_acceptance are 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

additional_requirements

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.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.bridge.xyz/v0/customers \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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

401Missing or invalid API key

500Unexpected error. User may try and send the request again.