Create a customer

curl --request POST \
  --url https://api.bridge.xyz/v0/customers \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "type": "individual",
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "transliterated_first_name": "<string>",
  "transliterated_middle_name": "<string>",
  "transliterated_last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "residential_address": {
    "street_line_1": "<string>",
    "street_line_2": "<string>",
    "city": "<string>",
    "subdivision": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "transliterated_residential_address": {
    "street_line_1": "<string>",
    "street_line_2": "<string>",
    "city": "<string>",
    "subdivision": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "birth_date": "<string>",
  "signed_agreement_id": "<string>",
  "endorsements": [
    "base"
  ],
  "account_purpose": "charitable_donations",
  "account_purpose_other": "<string>",
  "employment_status": "employed",
  "expected_monthly_payments_usd": "0_4999",
  "acting_as_intermediary": true,
  "most_recent_occupation": "<string>",
  "source_of_funds": "company_funds",
  "nationality": "<string>",
  "verified_govid_at": "<string>",
  "verified_selfie_at": "<string>",
  "completed_customer_safety_check_at": "<string>",
  "identifying_information": [
    {
      "type": "drivers_license",
      "issuing_country": "<string>",
      "number": "<string>",
      "description": "<string>",
      "expiration": "<string>",
      "image_front": "<string>",
      "image_back": "<string>"
    }
  ],
  "documents": [
    {
      "purposes": [
        "proof_of_account_purpose"
      ],
      "file": "<string>",
      "description": "<string>"
    }
  ]
}'

{
  "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"
}

POST

customers

Create a customer

curl --request POST \
  --url https://api.bridge.xyz/v0/customers \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "type": "individual",
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "transliterated_first_name": "<string>",
  "transliterated_middle_name": "<string>",
  "transliterated_last_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "residential_address": {
    "street_line_1": "<string>",
    "street_line_2": "<string>",
    "city": "<string>",
    "subdivision": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "transliterated_residential_address": {
    "street_line_1": "<string>",
    "street_line_2": "<string>",
    "city": "<string>",
    "subdivision": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "birth_date": "<string>",
  "signed_agreement_id": "<string>",
  "endorsements": [
    "base"
  ],
  "account_purpose": "charitable_donations",
  "account_purpose_other": "<string>",
  "employment_status": "employed",
  "expected_monthly_payments_usd": "0_4999",
  "acting_as_intermediary": true,
  "most_recent_occupation": "<string>",
  "source_of_funds": "company_funds",
  "nationality": "<string>",
  "verified_govid_at": "<string>",
  "verified_selfie_at": "<string>",
  "completed_customer_safety_check_at": "<string>",
  "identifying_information": [
    {
      "type": "drivers_license",
      "issuing_country": "<string>",
      "number": "<string>",
      "description": "<string>",
      "expiration": "<string>",
      "image_front": "<string>",
      "image_back": "<string>"
    }
  ],
  "documents": [
    {
      "purposes": [
        "proof_of_account_purpose"
      ],
      "file": "<string>",
      "description": "<string>"
    }
  ]
}'

{
  "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

Headers

Idempotency-Key

string

required

Body

application/json

Customer object to be created.

For individual customers (soon to be businesses as well), no fields are strictly required by the API. For example, it is valid to create a customer without a first name, last name, or residential address, but this customer will not be granted endorsements required to transact on Bridge until the necessary information is provided, possibly via a PUT request.

type

enum<string>

required

Type of the customer (individual vs. business).

Available options:

individual

first_name

string

The first name of the individual.

Required string length: 2 - 1024

middle_name

string

The middle name of the individual.

Required string length: 1 - 1024

last_name

string

The last name of the individual.

Required string length: 2 - 1024

transliterated_first_name

string

Required when the first_name includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~

Required string length: 1 - 256

transliterated_middle_name

string

Required when the middle_name includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~

Required string length: 1 - 256

transliterated_last_name

string

Required when the last_name includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~

Required string length: 1 - 256

string

The individuals primary email address

Required string length: 1 - 1024

phone

string

The individuals primary phone number in format "+12223334444"

Required string length: 1 - 1024

residential_address

object

The residential address of the individual. This must be a physical address, not a PO Box.

Show child attributes

transliterated_residential_address

object

Required when any part of the residential_address includes any non Latin-1 characters. Acceptable characters - Latin-1 Unicode Character Range: À-ÖØ-ßà-öø-ÿ; Standard Unicode Character Range: -~

Show child attributes

birth_date

string

Date of birth in format yyyy-mm-dd. Must be at least 18 years old.

Required string length: 10

signed_agreement_id

string

The ID of the signed agreement that the customer completed. You can get a signed agreement id for a new customer by following this guide here.

Required string length: 1 - 1024

endorsements

enum<string>[]

List of endorsements to request for this customer. If omitted, we'll attempt to grant base and sepa.

proof_of_address document is required for sepa to be approved

Show child attributes

account_purpose

enum<string>

What is the primary purpose of the customer's account?

Required for high risk customers. More information found here

Available options:

charitable_donations,

ecommerce_retail_payments,

investment_purposes,

operating_a_company,

other,

payments_to_friends_or_family_abroad,

personal_or_living_expenses,

protect_wealth,

purchase_goods_and_services,

receive_payment_for_freelancing,

receive_salary

account_purpose_other

string

A supplemental description of the account_purpose.

Required if the account_purpose is other.

employment_status

enum<string>

What is the customer's current employment status?

Required for high risk customers. More information found here

Available options:

employed,

homemaker,

retired,

self_employed,

student,

unemployed

expected_monthly_payments_usd

enum<string>

What is the expected monthly volume of payments the customer will be sending or receiving?

Required for high risk customers. More information found here

Available options:

0_4999,

5000_9999,

10000_49999,

50000_plus

acting_as_intermediary

boolean

Is the customer acting as an intermediary for a third party?

Required for high risk customers. More information found here

most_recent_occupation

string

What is the customer's most recent occupation? Specify the relevant alphanumeric occupation code. See the list of occupations for the complete list of valid occupations and codes. Required for Restricted countries.

Required for high risk customers. More information found here

source_of_funds

enum<string>

The individuals source of funds, e.g. government_benefits, investments_loans, salary, etc.

Required for high risk customers. More information found here

Available options:

company_funds,

ecommerce_reseller,

gambling_proceeds,

gifts,

government_benefits,

inheritance,

investments_loans,

pension_retirement,

salary,

sale_of_assets_real_estate,

savings,

someone_elses_funds

nationality

string

The ISO 3166-1 (three-character) country code representing the nationality of the customer.

verified_govid_at

string

The timestamp for when individual's government ID was successfully verified.

verified_selfie_at

string

The timestamp for when individual's selfie was successfully verified.

completed_customer_safety_check_at

string

The timestamp for when individual successfully passed customer safety check.

identifying_information

Identification Information · object[]

Show child attributes

documents

Documents · object[]

Please click "ADD OBJECT" for more information.

Show child attributes

Response

Customer object created

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

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

Show child attributes

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.

Show child attributes

requirements_due

enum<string>[]

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

Show child attributes

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

Show child attributes

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.

Show child attributes

Get all customers Get a single customer object

Endpoints

Authorizations

Headers

Body

Response