Sign in
latestOpenAPI 3.1.02026-08-102051102.0 KB

40ed0bdb89e1

Customers

Update customer key details and entitlements

patch/api/v1/customer/{customerId}

Path parameters

customerIdstring uuid required

Customer UUID

Customer UUID

Request body

entitlementsstring[]

Feature-based entitlements for the customer

emailstring email

Email address

phonestring e164

Phone number

metadataMetadata
first_namestring

First name of the applicant

last_namestring

Last name of the applicant

middle_namestring

Middle name of the applicant

dobstring

Date of birth in YYYY-MM-DD format

nationalitystring

Country code

tax_id_numberstring

Tax Identification Number (TIN)

company_namestring

Company name

countrystring

Country code (ISO 3166-1 alpha-2)

registration_numberstring

Registration number

incorporated_onstring

Date of incorporation in YYYY-MM-DD format

typestring

Company type

tax_idstring

Tax ID

registration_locationstring

Registration location (country-specific, e.g., state for USA)

websitestring uri

Website URL

alternative_namesstring[]

Alternative names (brand names or local language variants)

describe_businessstring

Description of the business

conduct_money_servicesboolean

Whether the company conducts money services

describe_compliance_controlsstring

Description of compliance controls

main_source_of_funds'BUSINESS_LOANS' | 'GRANTS' | 'INTER_COMPANY_FUNDS' | 'INVESTMENT_PROCEEDS' | 'LEGAL_SETTLEMENT' | 'OWNERS_CAPITAL' | 'PENSION_RETIREMENT' | 'SALE_OF_ASSETS' | 'SALES_OF_GOODS_AND_SERVICES' | 'THIRD_PARTY_FUNDS' | 'TREASURY_RESERVES'

Main source of funds

how_did_you_come_across_stablesstring

How did you come across Stables?

describe_money_servicesstring

Describe the money services your business conducts (required if conductMoneyServices is true)

account_purpose'CHARITABLE_DONATIONS' | 'ECOMMERCE_RETAIL_PAYMENTS' | 'INVESTMENT_PURPOSES' | 'PAYMENTS_TO_FRIENDS_OR_FAMILY_ABROAD' | 'PAYROLL' | 'PERSONAL_OR_LIVING_EXPENSES' | 'PROTECT_WEALTH' | 'PURCHASE_GOODS_AND_SERVICES' | 'RECEIVE_PAYMENTS_FOR_GOODS_AND_SERVICES' | 'TAX_OPTIMIZATION' | 'THIRD_PARTY_MONEY_TRANSMISSION' | 'TREASURY_MANAGEMENT' | 'OTHER'

What will you use Stables for?

account_purpose_otherstring

Explain what you would use Stables for (required if accountPurpose is other)

is_daoboolean

Is your business a DAO?

industry_selectionstring

What industry is your business in? (NAICS code)

expected_annual_revenue'0_99999' | '100000_999999' | '1000000_9999999' | '10000000_49999999' | '50000000_249999999' | '250000000_plus'

Estimated annual revenue in USD

expected_monthly_paymentsstring

Expected monthly payments in USD (numeric)

source_of_funds'BUSINESS_LOANS' | 'GRANTS' | 'INTER_COMPANY_FUNDS' | 'INVESTMENT_PROCEEDS' | 'LEGAL_SETTLEMENT' | 'OWNERS_CAPITAL' | 'PENSION_RETIREMENT' | 'SALE_OF_ASSETS' | 'SALES_OF_GOODS_AND_SERVICES' | 'THIRD_PARTY_FUNDS' | 'TREASURY_RESERVES'

Source of funds

source_of_funds_descriptionstring

Describe where your business funds come from

operate_in_prohibited_countryboolean

Does your business operate in any prohibited countries?

does_your_business_engage_in_high_risk_activities'yes' | 'no'

Does your business potentially engage in any High Risk activities?

high_risk_activitiesstring[]

High risk activities (required if doesYourBusinessEngageInHighRiskActivities is yes)

accept_termsboolean

Accept Stables' terms of service and privacy policy

bank_statement_file_datastring

Bank statement file data (base64 encoded data URL, e.g., data:image/jpeg;base64,...)

flow_of_funds_file_datastring

Flow of funds document file data (base64 encoded data URL, required if conductMoneyServices is true)

Response

Default Response

customer_idstring uuid required

Customer UUID

external_customer_idstring nullable required
customer_type'individual' | 'business' required

Type of customer in display format

emailstring email required
phonestring e164

Phone number in E.164 format (e.g., +14155552671)

first_namestring

First name (for individuals)

last_namestring

Last name (for individuals)

company_namestring

Company name (for businesses)

created_atstring date-time required
updated_atstring date-time required
metadataMetadata
statusstring

Customer compliance status