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>",
"birth_date": "<string>",
"signed_agreement_id": "<string>",
"endorsements": [],
"account_purpose_other": "<string>",
"acting_as_intermediary": true,
"most_recent_occupation": "<string>",
"nationality": "<string>",
"nationalities": [
"<string>"
],
"place_of_birth": {
"country": "<string>",
"city": "<string>"
},
"verified_database_at": "2023-11-07T05:31:56Z",
"verified_govid_at": "2023-11-07T05:31:56Z",
"verified_selfie_at": "2023-11-07T05:31:56Z",
"liveness_check_selfies": [
{
"image": "<string>"
}
],
"identifying_information": [
{
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"documents": [
{
"purposes": [],
"file": "<string>",
"description": "<string>"
}
],
"client_reference_id": "<string>"
}
'import requests
url = "https://api.bridge.xyz/v0/customers"
payload = {
"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>",
"birth_date": "<string>",
"signed_agreement_id": "<string>",
"endorsements": [],
"account_purpose_other": "<string>",
"acting_as_intermediary": True,
"most_recent_occupation": "<string>",
"nationality": "<string>",
"nationalities": ["<string>"],
"place_of_birth": {
"country": "<string>",
"city": "<string>"
},
"verified_database_at": "2023-11-07T05:31:56Z",
"verified_govid_at": "2023-11-07T05:31:56Z",
"verified_selfie_at": "2023-11-07T05:31:56Z",
"liveness_check_selfies": [{ "image": "<string>" }],
"identifying_information": [
{
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"documents": [
{
"purposes": [],
"file": "<string>",
"description": "<string>"
}
],
"client_reference_id": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>',
birth_date: '<string>',
signed_agreement_id: '<string>',
endorsements: [],
account_purpose_other: '<string>',
acting_as_intermediary: true,
most_recent_occupation: '<string>',
nationality: '<string>',
nationalities: ['<string>'],
place_of_birth: {country: '<string>', city: '<string>'},
verified_database_at: '2023-11-07T05:31:56Z',
verified_govid_at: '2023-11-07T05:31:56Z',
verified_selfie_at: '2023-11-07T05:31:56Z',
liveness_check_selfies: [{image: '<string>'}],
identifying_information: [
{
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
documents: [{purposes: [], file: '<string>', description: '<string>'}],
client_reference_id: '<string>'
})
};
fetch('https://api.bridge.xyz/v0/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bridge.xyz/v0/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'birth_date' => '<string>',
'signed_agreement_id' => '<string>',
'endorsements' => [
],
'account_purpose_other' => '<string>',
'acting_as_intermediary' => true,
'most_recent_occupation' => '<string>',
'nationality' => '<string>',
'nationalities' => [
'<string>'
],
'place_of_birth' => [
'country' => '<string>',
'city' => '<string>'
],
'verified_database_at' => '2023-11-07T05:31:56Z',
'verified_govid_at' => '2023-11-07T05:31:56Z',
'verified_selfie_at' => '2023-11-07T05:31:56Z',
'liveness_check_selfies' => [
[
'image' => '<string>'
]
],
'identifying_information' => [
[
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'documents' => [
[
'purposes' => [
],
'file' => '<string>',
'description' => '<string>'
]
],
'client_reference_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bridge.xyz/v0/customers"
payload := strings.NewReader("{\n \"type\": \"individual\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"signed_agreement_id\": \"<string>\",\n \"endorsements\": [],\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"nationality\": \"<string>\",\n \"nationalities\": [\n \"<string>\"\n ],\n \"place_of_birth\": {\n \"country\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_selfie_at\": \"2023-11-07T05:31:56Z\",\n \"liveness_check_selfies\": [\n {\n \"image\": \"<string>\"\n }\n ],\n \"identifying_information\": [\n {\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"client_reference_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/customers")
.header("Idempotency-Key", "<idempotency-key>")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"individual\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"signed_agreement_id\": \"<string>\",\n \"endorsements\": [],\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"nationality\": \"<string>\",\n \"nationalities\": [\n \"<string>\"\n ],\n \"place_of_birth\": {\n \"country\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_selfie_at\": \"2023-11-07T05:31:56Z\",\n \"liveness_check_selfies\": [\n {\n \"image\": \"<string>\"\n }\n ],\n \"identifying_information\": [\n {\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"client_reference_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bridge.xyz/v0/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"individual\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"signed_agreement_id\": \"<string>\",\n \"endorsements\": [],\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"nationality\": \"<string>\",\n \"nationalities\": [\n \"<string>\"\n ],\n \"place_of_birth\": {\n \"country\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_selfie_at\": \"2023-11-07T05:31:56Z\",\n \"liveness_check_selfies\": [\n {\n \"image\": \"<string>\"\n }\n ],\n \"identifying_information\": [\n {\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"client_reference_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "00000000-0000-0000-0000-000000000000",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com",
"client_reference_id": "your_internal_id_123",
"status": "active",
"type": "individual",
"persona_inquiry_type": "gov_id_db",
"created_at": "2025-11-19T21:14:58.328Z",
"updated_at": "2025-11-19T21:16:02.894Z",
"rejection_reasons": [],
"has_accepted_terms_of_service": true,
"endorsements": [
{
"name": "base",
"status": "approved",
"requirements": {
"complete": [
"terms_of_service_v1",
"first_name",
"last_name",
"tax_identification_number",
"email_address",
"address_of_residence",
"date_of_birth",
"proof_of_address",
"sanctions_screen",
"pep_screen",
"blocklist_lookup",
"min_age_18",
"selfie_verification",
"government_id_rejection_checks_passed",
"government_id_review_checks_passed",
"government_id_reliance",
"post_processing"
],
"pending": [],
"missing": null,
"issues": []
}
},
{
"name": "sepa",
"status": "approved",
"requirements": {
"complete": [
"terms_of_service_v2",
"first_name",
"last_name",
"tax_identification_number",
"email_address",
"address_of_residence",
"date_of_birth",
"proof_of_address",
"sanctions_screen",
"pep_screen",
"blocklist_lookup",
"min_age_18",
"selfie_verification",
"government_id_rejection_checks_passed",
"government_id_review_checks_passed",
"government_id_reliance"
],
"pending": [],
"missing": null,
"issues": []
}
}
],
"future_requirements_due": [],
"requirements_due": [
"external_account"
],
"capabilities": {
"payin_crypto": "active",
"payout_crypto": "active",
"payin_fiat": "pending",
"payout_fiat": "pending"
}
}Customers
Create a customer
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>",
"birth_date": "<string>",
"signed_agreement_id": "<string>",
"endorsements": [],
"account_purpose_other": "<string>",
"acting_as_intermediary": true,
"most_recent_occupation": "<string>",
"nationality": "<string>",
"nationalities": [
"<string>"
],
"place_of_birth": {
"country": "<string>",
"city": "<string>"
},
"verified_database_at": "2023-11-07T05:31:56Z",
"verified_govid_at": "2023-11-07T05:31:56Z",
"verified_selfie_at": "2023-11-07T05:31:56Z",
"liveness_check_selfies": [
{
"image": "<string>"
}
],
"identifying_information": [
{
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"documents": [
{
"purposes": [],
"file": "<string>",
"description": "<string>"
}
],
"client_reference_id": "<string>"
}
'import requests
url = "https://api.bridge.xyz/v0/customers"
payload = {
"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>",
"birth_date": "<string>",
"signed_agreement_id": "<string>",
"endorsements": [],
"account_purpose_other": "<string>",
"acting_as_intermediary": True,
"most_recent_occupation": "<string>",
"nationality": "<string>",
"nationalities": ["<string>"],
"place_of_birth": {
"country": "<string>",
"city": "<string>"
},
"verified_database_at": "2023-11-07T05:31:56Z",
"verified_govid_at": "2023-11-07T05:31:56Z",
"verified_selfie_at": "2023-11-07T05:31:56Z",
"liveness_check_selfies": [{ "image": "<string>" }],
"identifying_information": [
{
"issuing_country": "<string>",
"number": "<string>",
"description": "<string>",
"expiration": "<string>",
"image_front": "<string>",
"image_back": "<string>"
}
],
"documents": [
{
"purposes": [],
"file": "<string>",
"description": "<string>"
}
],
"client_reference_id": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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>',
birth_date: '<string>',
signed_agreement_id: '<string>',
endorsements: [],
account_purpose_other: '<string>',
acting_as_intermediary: true,
most_recent_occupation: '<string>',
nationality: '<string>',
nationalities: ['<string>'],
place_of_birth: {country: '<string>', city: '<string>'},
verified_database_at: '2023-11-07T05:31:56Z',
verified_govid_at: '2023-11-07T05:31:56Z',
verified_selfie_at: '2023-11-07T05:31:56Z',
liveness_check_selfies: [{image: '<string>'}],
identifying_information: [
{
issuing_country: '<string>',
number: '<string>',
description: '<string>',
expiration: '<string>',
image_front: '<string>',
image_back: '<string>'
}
],
documents: [{purposes: [], file: '<string>', description: '<string>'}],
client_reference_id: '<string>'
})
};
fetch('https://api.bridge.xyz/v0/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bridge.xyz/v0/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'birth_date' => '<string>',
'signed_agreement_id' => '<string>',
'endorsements' => [
],
'account_purpose_other' => '<string>',
'acting_as_intermediary' => true,
'most_recent_occupation' => '<string>',
'nationality' => '<string>',
'nationalities' => [
'<string>'
],
'place_of_birth' => [
'country' => '<string>',
'city' => '<string>'
],
'verified_database_at' => '2023-11-07T05:31:56Z',
'verified_govid_at' => '2023-11-07T05:31:56Z',
'verified_selfie_at' => '2023-11-07T05:31:56Z',
'liveness_check_selfies' => [
[
'image' => '<string>'
]
],
'identifying_information' => [
[
'issuing_country' => '<string>',
'number' => '<string>',
'description' => '<string>',
'expiration' => '<string>',
'image_front' => '<string>',
'image_back' => '<string>'
]
],
'documents' => [
[
'purposes' => [
],
'file' => '<string>',
'description' => '<string>'
]
],
'client_reference_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bridge.xyz/v0/customers"
payload := strings.NewReader("{\n \"type\": \"individual\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"signed_agreement_id\": \"<string>\",\n \"endorsements\": [],\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"nationality\": \"<string>\",\n \"nationalities\": [\n \"<string>\"\n ],\n \"place_of_birth\": {\n \"country\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_selfie_at\": \"2023-11-07T05:31:56Z\",\n \"liveness_check_selfies\": [\n {\n \"image\": \"<string>\"\n }\n ],\n \"identifying_information\": [\n {\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"client_reference_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bridge.xyz/v0/customers")
.header("Idempotency-Key", "<idempotency-key>")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"individual\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"signed_agreement_id\": \"<string>\",\n \"endorsements\": [],\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"nationality\": \"<string>\",\n \"nationalities\": [\n \"<string>\"\n ],\n \"place_of_birth\": {\n \"country\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_selfie_at\": \"2023-11-07T05:31:56Z\",\n \"liveness_check_selfies\": [\n {\n \"image\": \"<string>\"\n }\n ],\n \"identifying_information\": [\n {\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"client_reference_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bridge.xyz/v0/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"individual\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"transliterated_first_name\": \"<string>\",\n \"transliterated_middle_name\": \"<string>\",\n \"transliterated_last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"signed_agreement_id\": \"<string>\",\n \"endorsements\": [],\n \"account_purpose_other\": \"<string>\",\n \"acting_as_intermediary\": true,\n \"most_recent_occupation\": \"<string>\",\n \"nationality\": \"<string>\",\n \"nationalities\": [\n \"<string>\"\n ],\n \"place_of_birth\": {\n \"country\": \"<string>\",\n \"city\": \"<string>\"\n },\n \"verified_database_at\": \"2023-11-07T05:31:56Z\",\n \"verified_govid_at\": \"2023-11-07T05:31:56Z\",\n \"verified_selfie_at\": \"2023-11-07T05:31:56Z\",\n \"liveness_check_selfies\": [\n {\n \"image\": \"<string>\"\n }\n ],\n \"identifying_information\": [\n {\n \"issuing_country\": \"<string>\",\n \"number\": \"<string>\",\n \"description\": \"<string>\",\n \"expiration\": \"<string>\",\n \"image_front\": \"<string>\",\n \"image_back\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"purposes\": [],\n \"file\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"client_reference_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "00000000-0000-0000-0000-000000000000",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com",
"client_reference_id": "your_internal_id_123",
"status": "active",
"type": "individual",
"persona_inquiry_type": "gov_id_db",
"created_at": "2025-11-19T21:14:58.328Z",
"updated_at": "2025-11-19T21:16:02.894Z",
"rejection_reasons": [],
"has_accepted_terms_of_service": true,
"endorsements": [
{
"name": "base",
"status": "approved",
"requirements": {
"complete": [
"terms_of_service_v1",
"first_name",
"last_name",
"tax_identification_number",
"email_address",
"address_of_residence",
"date_of_birth",
"proof_of_address",
"sanctions_screen",
"pep_screen",
"blocklist_lookup",
"min_age_18",
"selfie_verification",
"government_id_rejection_checks_passed",
"government_id_review_checks_passed",
"government_id_reliance",
"post_processing"
],
"pending": [],
"missing": null,
"issues": []
}
},
{
"name": "sepa",
"status": "approved",
"requirements": {
"complete": [
"terms_of_service_v2",
"first_name",
"last_name",
"tax_identification_number",
"email_address",
"address_of_residence",
"date_of_birth",
"proof_of_address",
"sanctions_screen",
"pep_screen",
"blocklist_lookup",
"min_age_18",
"selfie_verification",
"government_id_rejection_checks_passed",
"government_id_review_checks_passed",
"government_id_reliance"
],
"pending": [],
"missing": null,
"issues": []
}
}
],
"future_requirements_due": [],
"requirements_due": [
"external_account"
],
"capabilities": {
"payin_crypto": "active",
"payout_crypto": "active",
"payin_fiat": "pending",
"payout_fiat": "pending"
}
}Authorizations
Headers
Body
application/json
Customer object to be created.
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.
- Individual Customer
- Business Customer
Type of the customer (individual vs. business).
Available options:
individual Minimum string length:
1The first name of the individual.
Required string length:
2 - 1024The middle name of the individual.
Required string length:
1 - 1024The last name of the individual.
Required string length:
2 - 1024Required 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 - 256Required 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 - 256Required 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 - 256The individuals primary email address
Required string length:
1 - 1024The individuals primary phone number in format "+12223334444"
Required string length:
1 - 1024The residential address of the individual. This must be a physical address, not a PO Box.
Show child attributes
Show child attributes
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
Show child attributes
Date of birth in format yyyy-mm-dd. Must be at least 18 years old.
Required string length:
10List of endorsements to request for this customer. If omitted, we'll attempt to grant base and sepa.
The type of endorsement. Note: pix_onramp (BRL deposits via PIX) and pix_offramp (BRL withdrawals via PIX) can be requested individually for granular access. Requesting pix grants both directional endorsements. pix_onramp is not supported for non-BR individuals; if requested (or requested via pix) it will remain in an endorsement_not_available_in_customers_region state and no action is required.
Available options:
base, cards, cop, faster_payments, pix, pix_onramp, pix_offramp, sepa, spei What is the primary purpose of the customer's account?
Required for high risk customers. More information found here.
EEA / BBSA in-scope individuals: also required under program rules (not for associated persons). See EEA updated requirements.
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 A supplemental description of the account_purpose.
Required if the account_purpose is other.
What is the customer's current employment status?
Required for high risk customers. More information found here.
EEA / BBSA in-scope individuals: also required under program rules (not for associated persons). See EEA updated requirements.
Available options:
employed, homemaker, retired, self_employed, student, unemployed 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
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 Legacy single nationality as ISO 3166-1 alpha-3. Prefer nationalities to send all nationalities. During migration Bridge honors either field; nationality will be deprecated after migration. EEA / BBSA program: see Nationalities.
All nationalities held by the customer (ISO 3166-1 alpha-3 codes). EEA / BBSA in-scope individuals: required. See EEA updated requirements.
Required string length:
3Country (and optionally city) of birth. EEA / BBSA in-scope customers: supply when onboarding individuals or associated persons under the EEA updated requirements. This is a sparse address — no street address. At least country should be present when the object is sent; city is recommended and will be required by EU law in 2027.
Show child attributes
Show child attributes
Write-only ISO 8601 timestamp. For EEA in-scope customers on reliance (TWO_FORMS_OF_ID_RELIANCE in eea_requirements.rb), may stand in for a database identity check together with verified_govid_at. See EEA updated requirements — identity.
Write-only ISO 8601 timestamp. For EEA in-scope customers on reliance, use with a second factor (verified_selfie_at or verified_database_at) per TWO_FORMS_OF_ID_RELIANCE. See EEA updated requirements.
Write-only ISO 8601 timestamp. For EEA in-scope customers on reliance, pairs with verified_govid_at or verified_database_at under TWO_FORMS_OF_ID_RELIANCE.
Selfie images to submit for Bridge's liveness verification. Use this when you are collecting the customer's selfie on behalf of Bridge.
EEA in-scope customers: selfies submitted via this field are not sufficient. The selfie must be collected through the Persona hosted flow (via a KYC link). See EEA updated requirements.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Please click "ADD OBJECT" for more information.
Show child attributes
Show child attributes
Caller-provided identifier used to correlate this customer with your internal records. Returned in API and webhook responses.
Required string length:
1 - 256Response
Customer object created
A UUID that uniquely identifies a resource
Required string length:
1 - 42Pattern:
[a-z0-9]*Required string length:
1 - 1024Maximum string length:
1024Required string length:
1 - 1024Required string length:
1 - 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.
deposits_restricted: represents a customer's account that is currently restricted from making new deposits because of activity on the platform.
Available options:
active, awaiting_questionnaire, awaiting_ubo, deposits_restricted, incomplete, not_started, offboarded, paused, rejected, under_review Show child attributes
Show child attributes
This field is deprecated. See endorsements.missing instead.
Available options:
id_verification KYC requirements still needed to be completed. Please consult our KYC guide on how to resolve each requirement.
Available options:
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
Show child attributes
Whether the customer has accepted the terms of service.
Caller-provided identifier used to correlate this customer with your internal records. Returned in API and webhook responses.
Required string length:
1 - 256A summary of whether the customer has received approvals to complete onboarding or use certain products/services offered by Bridge.
Show child attributes
Show child attributes
Was this page helpful?