curl --request POST \
--url https://api.bridge.xyz/v0/customers \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--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_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"
}
curl --request POST \
--url https://api.bridge.xyz/v0/customers \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--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_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"
}
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.
The body is of type object
.
Customer object created
The response is of type object
.
Was this page helpful?