Update business customer

curl --request PUT \ --url http://localhost:4000/v1/payout/rails/customers \ --header 'Content-Type: application/json' \ --data ' { "email": "[email protected]", "business_legal_name": "Acme Corporation LLC", "business_type": "llc", "business_description": "A fintech company providing cross-border payment solutions.", "signed_agreement_id": "sa_abc123def456", "is_dao": false, "primary_website": "https://acme.com", "identifying_information": [ { "type": "ssn", "issuing_country": "USA", "number": "123-45-6789", "description": "<string>", "expiration": "2030-12-31", "image_front": "<string>", "image_back": "<string>" } ], "business_formation_document": { "image_front": "https://xyz.supabase.co/storage/v1/object/public/docs/formation.pdf", "image_back": "https://xyz.supabase.co/storage/v1/object/public/docs/formation-back.pdf" }, "proof_of_nature_of_business_document": { "image_front": "https://xyz.supabase.co/storage/v1/object/public/docs/formation.pdf", "image_back": "https://xyz.supabase.co/storage/v1/object/public/docs/formation-back.pdf" }, "business_ownership_document": { "image_front": "https://xyz.supabase.co/storage/v1/object/public/docs/formation.pdf", "image_back": "https://xyz.supabase.co/storage/v1/object/public/docs/formation-back.pdf" }, "registered_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "physical_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "associated_persons": [ { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "residential_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "birth_date": "1990-01-15", "has_ownership": true, "has_control": true, "is_signer": true, "identifying_information": [ { "type": "ssn", "issuing_country": "USA", "number": "123-45-6789", "description": "<string>", "expiration": "2030-12-31", "image_front": "<string>", "image_back": "<string>" } ], "middle_name": "Michael", "transliterated_first_name": "<string>", "transliterated_middle_name": "<string>", "transliterated_last_name": "<string>", "phone": "+12223334444", "transliterated_residential_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "is_director": false, "title": "CEO", "ownership_percentage": 75, "attested_ownership_structure_at": "2024-06-15", "relationship_established_at": "2020-01-01", "verified_govid_at": "<string>", "verified_selfie_at": "<string>", "completed_customer_safety_check_at": "<string>", "documents": [ { "purpose": "proof_of_address", "image_front": "<string>", "image_back": "<string>" } ] } ], "other_websites": [ "https://twitter.com/acme" ], "transliterated_registered_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "transliterated_physical_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "endorsements": [ "base", "spei" ], "business_industry": [ "6199" ], "account_purpose": "receive_payments_for_goods_and_services", "source_of_funds": "sales_of_goods_and_services", "estimated_annual_revenue_usd": "1000000_9999999", "expected_monthly_payments_usd": 50000, "conducts_money_services": false, "conducts_money_services_using_bridge": false, "conducts_money_services_description": "<string>", "compliance_screening_explanation": "<string>", "operates_in_prohibited_countries": false, "high_risk_activities": [ "none_of_the_above" ], "acting_as_intermediary": false, "ownership_threshold": 25, "has_material_intermediary_ownership": false } '

{ "id": "e3b0c442-98fc-1c14-b39f-92d1282e8b7a", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "status": "active", "type": "individual", "capabilities": { "payin_crypto": "pending", "payout_crypto": "pending", "payin_fiat": "pending", "payout_fiat": "pending" }, "requirements_due": [], "future_requirements_due": [], "created_at": "2024-01-01T00:00:00Z", "updated_at": "2024-01-01T00:00:00Z", "rejection_reasons": [ { "developer_reason": "Insufficient documentation provided", "reason": "We were unable to verify your identity", "created_at": "2026-01-15T12:00:00.000Z" } ], "has_accepted_terms_of_service": true, "endorsements": [ { "name": "base", "status": "incomplete", "requirements": { "complete": [ "<string>" ], "pending": [ "<string>" ], "issues": [ "<string>" ], "missing": {} }, "additional_requirements": [ "<string>" ] } ], "persona_inquiry_type": "gov_id_db", "tos_link": "https://compliance.bridge.xyz/accept-terms-of-service?customer_id=...", "associated_persons": [ { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "residential_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "birth_date": "1990-01-15", "has_ownership": true, "has_control": true, "is_signer": true, "identifying_information": [ { "type": "ssn", "issuing_country": "USA", "number": "123-45-6789", "description": "<string>", "expiration": "2030-12-31", "image_front": "<string>", "image_back": "<string>" } ], "middle_name": "Michael", "transliterated_first_name": "<string>", "transliterated_middle_name": "<string>", "transliterated_last_name": "<string>", "phone": "+12223334444", "transliterated_residential_address": { "street_line_1": "123 Main St", "city": "San Francisco", "country": "USA", "street_line_2": "Suite 200", "subdivision": "CA", "postal_code": "94102" }, "is_director": false, "title": "CEO", "ownership_percentage": 75, "attested_ownership_structure_at": "2024-06-15", "relationship_established_at": "2020-01-01", "verified_govid_at": "<string>", "verified_selfie_at": "<string>", "completed_customer_safety_check_at": "<string>", "documents": [ { "purpose": "proof_of_address", "image_front": "<string>", "image_back": "<string>" } ] } ] }

Body

application/json

string

Update the business email address.

Example:

"[email protected]"

business_legal_name

string

Update the business legal name.

Example:

"Acme Corporation LLC"

business_type

enum<string>

Update the business type.

Available options:

cooperative,

corporation,

llc,

other,

partnership,

sole_prop,

trust

Example:

"llc"

business_description

string

Update the business description.

Example:

"A fintech company providing cross-border payment solutions."

signed_agreement_id

string

The signed agreement ID.

Example:

"sa_abc123def456"

is_dao

boolean

Whether the business is a DAO.

Example:

false

primary_website

string

Primary website of the business.

Example:

"https://acme.com"

identifying_information

object[]

Tax identification documents for the business (e.g. EIN, RFC). Image fields accept Supabase storage URLs — the backend converts them to base64 data-uri for Bridge API.

Show child attributes

business_formation_document

object

Business formation document (e.g. articles of incorporation, certificate of formation). Send Supabase storage URLs — the backend converts them to base64 data-uri for Bridge API.

Show child attributes

proof_of_nature_of_business_document

object

Proof of nature of business document (e.g. business license, operating agreement). Required if primary_website is not provided. Send Supabase storage URLs — the backend converts them to base64 data-uri for Bridge API.

Show child attributes

business_ownership_document

object

Business ownership document (e.g. ownership chart, cap table). Not required if a control person provides attested_ownership_structure_at. Send Supabase storage URLs — the backend converts them to base64 data-uri for Bridge API.

Show child attributes

registered_address

object

Update the registered address.

Show child attributes

physical_address

object

Update the physical address.

Show child attributes

associated_persons

object[]

Update associated persons.

Show child attributes

other_websites

string[]

Other websites and social media.

Example:

["https://twitter.com/acme"]

transliterated_registered_address

object

Transliterated registered address.

Show child attributes

transliterated_physical_address

object

Transliterated physical address.

Show child attributes

endorsements

string[]

Endorsements to request.

Example:

["base", "spei"]

business_industry

string[]

Industry codes.

Example:

["6199"]

account_purpose

string

Account purpose.

Example:

"receive_payments_for_goods_and_services"

source_of_funds

string

Source of funds.

Example:

"sales_of_goods_and_services"

estimated_annual_revenue_usd

string

Estimated annual revenue in USD.

Example:

"1000000_9999999"

expected_monthly_payments_usd

number

Expected monthly payments in USD.

Example:

50000

conducts_money_services

boolean

Whether the business offers money services.

Example:

false

conducts_money_services_using_bridge

boolean

Whether business conducts money services using Bridge.

Example:

false

conducts_money_services_description

string

Description of money services.

compliance_screening_explanation

string

Compliance screening explanation.

operates_in_prohibited_countries

boolean

Operates in prohibited countries.

Example:

false

high_risk_activities

string[]

High risk activities.

Example:

["none_of_the_above"]

acting_as_intermediary

boolean

Acting as intermediary.

Example:

false

ownership_threshold

number

Ownership threshold (5-25).

Example:

25

has_material_intermediary_ownership

boolean

Has material intermediary ownership.

Example:

false

Response

Business customer updated successfully

string

required

Example:

"e3b0c442-98fc-1c14-b39f-92d1282e8b7a"

first_name

string

required

Example:

"John"

last_name

object

required

Example:

"Doe"

string

required

Example:

"[email protected]"

status

enum<string>

required

Available options:

active,

awaiting_questionnaire,

awaiting_ubo,

incomplete,

not_started,

offboarded,

paused,

rejected,

under_review

Example:

"active"

type

enum<string>

required

Available options:

individual,

business

Example:

"individual"

capabilities

object

required

Show child attributes

requirements_due

enum<string>[]

required

Available options:

external_account,

id_verification

Example:

[]

future_requirements_due

enum<string>[]

required

Available options:

id_verification

Example:

[]

created_at

string

required

Example:

"2024-01-01T00:00:00Z"

updated_at

string

required

Example:

"2024-01-01T00:00:00Z"

rejection_reasons

object[]

required

Show child attributes

has_accepted_terms_of_service

boolean

required

Example:

true

endorsements

object[]

required

Show child attributes

persona_inquiry_type

string

Type of Persona inquiry used for verification (e.g. gov_id_db, business)

Example:

"gov_id_db"

tos_link

string

Bridge-hosted URL for the customer to accept Terms of Service.

Example:

"https://compliance.bridge.xyz/accept-terms-of-service?customer_id=..."

associated_persons

object[]

Associated persons for business customers (UBOs, controllers, etc.)

Show child attributes

Introduction

API Endpoints

Update business customer

Body

Response