Skip to main content
PUT
/
customers
/
{customerID}
Update a single customer object
curl --request PUT \
  --url https://api.bridge.xyz/v0/customers/{customerID} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
  "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>"
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*

Body

application/json

Customer object to update with

​
type
enum<string>

Type of the customer (individual vs. business).

Available options:
individual
Minimum string length: 1
​
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
​
email
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
write-only

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

​
transliterated_residential_address
object
write-only

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: -~

​
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
write-only

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>[]
write-only

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

The type of endorsement.

Available options:
base,
cards,
cop,
faster_payments,
pix,
sepa,
spei
​
account_purpose
enum<string>

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
​
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.

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
​
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
write-only

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.

​
nationalities
string[]
write-only

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: 3
​
place_of_birth
object
write-only

Country (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.

​
verified_database_at
string<date-time>
write-only

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.

​
verified_govid_at
string<date-time>
write-only

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.

​
verified_selfie_at
string<date-time>
write-only

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.

​
identifying_information
Identification Information · object[]
write-only
​
documents
Documents · object[]
write-only

Please click "ADD OBJECT" for more information.

​
client_reference_id
string

Caller-provided identifier used to correlate this customer with your internal records. Returned in API and webhook responses.

Required string length: 1 - 256

Response

Successful customer object response

​
id
string
read-only

A UUID that uniquely identifies a resource

Required string length: 1 - 42
Pattern: [a-z0-9]*
​
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
deprecated
​
future_requirements_due
enum<string>[]
deprecated
read-only

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.

Available options:
id_verification
​
requirements_due
enum<string>[]
deprecated
read-only

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

Available options:
external_account,
id_verification
​
created_at
string<date-time>
read-only

Time of creation of the customer

​
updated_at
string<date-time>
read-only

Time of last update of the customer

​
rejection_reasons
object[]
deprecated
read-only

Reasons why a customer KYC was rejected

​
has_accepted_terms_of_service
boolean
read-only

Whether the customer has accepted the terms of service.

​
client_reference_id
string

Caller-provided identifier used to correlate this customer with your internal records. Returned in API and webhook responses.

Required string length: 1 - 256
​
endorsements
object[]
read-only

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