DELETE
/
customers
/
{customerID}
Delete a single customer object
curl --request DELETE \
  --url https://api.bridge.xyz/v0/customers/{customerID} \
  --header 'Api-Key: <api-key>'
{
  "id": "cust_ind",
  "first_name": "John",
  "last_name": "Doe",
  "email": "johndoe@johndoe.com",
  "status": "active",
  "type": "individual",
  "has_accepted_terms_of_service": true,
  "address": {
    "street_line_1": "123 Washington St",
    "street_line_2": "Apt 2F",
    "city": "New York",
    "postal_code": "10001",
    "state": "NY",
    "country": "USA"
  },
  "rejection_reasons": [],
  "requirements_due": [
    "external_account"
  ],
  "future_requirements_due": [
    "id_verification"
  ],
  "endorsements": [
    {
      "name": "base",
      "status": "approved"
    },
    {
      "name": "sepa",
      "status": "incomplete",
      "additional_requirements": [
        "kyc_with_proof_of_address",
        "tos_v2_acceptance"
      ]
    }
  ],
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_at": "2020-01-02T00:00:00.000Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

Successfully deleted customer object response

​
id
string

A UUID that uniquely identifies a resource

Required string length: 1 - 42
​
first_name
string
Required string length: 1 - 1024
​
last_name
string
Required string length: 1 - 1024
​
email
string
Required string length: 1 - 1024
​
status
enum<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.

Available options:
active,
awaiting_questionnaire,
awaiting_ubo,
incomplete,
not_started,
offboarded,
paused,
rejected,
under_review
​
capabilities
object
​
future_requirements_due
enum<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
enum<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
object[]

Reasons why a customer KYC was rejected

​
has_accepted_terms_of_service
boolean

Whether the customer has accepted the terms of service.

​
endorsements
object[]

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