curl --request GET \
--url https://api.bridge.xyz/v0/customers \
--header 'Api-Key: <api-key>'{
"count": 123,
"data": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"status": "active",
"capabilities": {
"payin_crypto": "pending",
"payout_crypto": "pending",
"payin_fiat": "pending",
"payout_fiat": "pending"
},
"future_requirements_due": [
"id_verification"
],
"requirements_due": [
"external_account"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"rejection_reasons": [
{
"developer_reason": "<string>",
"reason": "<string>",
"created_at": "<string>"
}
],
"has_accepted_terms_of_service": true,
"endorsements": [
{
"name": "base",
"status": "incomplete",
"additional_requirements": [
"kyc_approval"
],
"requirements": {
"complete": [
"<string>"
],
"pending": [
"<string>"
],
"missing": {},
"issues": [
"<string>"
]
}
}
]
}
]
}Get the full list of all customers created on Bridge
curl --request GET \
--url https://api.bridge.xyz/v0/customers \
--header 'Api-Key: <api-key>'{
"count": 123,
"data": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"status": "active",
"capabilities": {
"payin_crypto": "pending",
"payout_crypto": "pending",
"payin_fiat": "pending",
"payout_fiat": "pending"
},
"future_requirements_due": [
"id_verification"
],
"requirements_due": [
"external_account"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"rejection_reasons": [
{
"developer_reason": "<string>",
"reason": "<string>",
"created_at": "<string>"
}
],
"has_accepted_terms_of_service": true,
"endorsements": [
{
"name": "base",
"status": "incomplete",
"additional_requirements": [
"kyc_approval"
],
"requirements": {
"complete": [
"<string>"
],
"pending": [
"<string>"
],
"missing": {},
"issues": [
"<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)
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)
The number of items to return (default of 10, max of 100)
If included, filters to customers with the given email
List of customers (the returned list is empty if none found)
total number of items in data
Show child attributes
A UUID that uniquely identifies a resource
1 - 421 - 10241 - 10241 - 1024offboarded: 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 Show child attributes
State of the customer capability
pending, active, inactive, rejected State of the customer capability
pending, active, inactive, rejected State of the customer capability
pending, active, inactive, rejected State of the customer capability
pending, active, inactive, rejected 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.
id_verification KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement.
external_account, id_verification Time of creation of the customer
Time of last update of the customer
Reasons why a customer KYC was rejected
Show child attributes
Developer information for why a customer was rejected. Not to be shared with the customer.
Reason for why a customer was rejected. To be shared with the customer.
Time of creation of the rejection reason
Whether the customer has accepted the terms of service.
A summary of whether the customer has received approvals to complete onboarding or use certain products/services offered by Bridge.
Show child attributes
The endorsement type.
base, sepa, spei, cards incomplete, approved, revoked 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.tos_v2_acceptance is required for sepa and kyc_with_proof_of_address may also be needed in certain situations. 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 stringkyc_approval, tos_acceptance, kyc_with_proof_of_address, tos_v2_acceptance 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.
Show child attributes
an array of requirements that have already been completed for this endorsement.
an array of requirements that are pending review for this endorsement.
an object that will specify an indepth breakdown of what items are missing for this endorsement.
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" }
Was this page helpful?