Skip to main content
PATCH
Updates KYB-mutable fields on the account. This endpoint never uploads company documents; use Upload Account Document for company evidence. Some changes apply immediately while material KYB changes require compliance review before they become approved data.
Updates are blocked once kyc_status is terminal (approved or rejected). Attempting to patch a terminal account returns a 422 business-rule error.
Update policy: contact/display corrections and unsubmitted draft fields can apply immediately. Legal name, business type, country of incorporation, registration number, tax identification number, operating address, and ownership-structure changes should be treated as compliance-reviewed changes and surfaced as pending requirements until approved.

​
Path Parameters

​
string
required
Platform customer id.
​
string
required
Account id.

​
Request Body

All fields are optional; omitted fields are left untouched.
​
string
Account display name. Max 255 characters.
​
string
Primary contact email.
​
string
Legal name of the business. Max 255 characters.
​
enum
Business structure (see business_type on Create Account).
​
string[]
Industry classifications.
​
string
Business registration number. Material changes require compliance review.
​
Address
Registered legal address (see the Address object on Create Account).
​
boolean
Set to true when the operating address matches the registered address.
​
Address | null
Operating address. Required when operating_address_same_as_registered is changed to false.
​
string
Tax identification number. Keep separate from business_registration_number unless a country-specific compliance rule says otherwise.
​
date
Date of incorporation, ISO 8601.
​
string
deprecated
Deprecated. Use country_code instead.
​
string
Business description. Required when website is not provided.
​
string
Primary business contact email.
​
string
Business website URL. Optional; if omitted, business_description is required. The merged account state must keep at least one of website / business_description, and an operating_address when operating_address_same_as_registered is false; violating patches are rejected with 422.
​
string[] | null
Configured source-of-funds options.
​
string | null
Expected monthly deposit volume bucket.
​
string | null
Expected monthly withdrawal volume bucket.
​
string[] | null
Purposes of the account (replaces the stored list when provided). Values come from the configured purpose-of-account options.

​
Response

Returns the updated account object.
​
string
Always account.
​
string
Account id.
​
string
Platform customer id.
​
enum | null
Entity type: individual or business.
​
enum | null
Verification status: not_started, under_review, action_needed, approved, or rejected.
​
string | null
Account display name.
​
string | null
Primary contact email.
​
string | null
ISO 3166-1 alpha-2 country code.
​
object[] | null
Populated only when kyc_status is rejected; each entry has a user-safe reason and a developer_reason for your integration logic (not for end-customer display). Null otherwise.
​
string
ISO 8601 timestamp when created.
​
string
ISO 8601 timestamp when last updated.
​
string | null
Actor that created the account.
​
string | null
Actor that last updated the account.