Skip to main content
POST
Submit regional compliance fields

Authorizations

Authorization
string
header
required

User bearer credential: either a Cognito JWT or an ak_ user API key. Backend integrators using HMAC must include the user API key alongside the three HMAC headers on user-scoped endpoints.

Body

Regional compliance fields for the authenticated user.

Regional compliance fields for the authenticated user.

placeOfBirth
object
required

Where the user was born.

nationalities
string[]
required

Every nationality the user holds, not just their primary one.

Minimum array length: 1

ISO 3166-1 alpha-3 country code.

Required string length: 3
Example:
accountPurpose
enum<string>
required

What the user intends to use the account for.

Available options:
charitable_donations,
ecommerce_retail_payments,
investment_purposes,
operating_a_company,
payments_to_friends_or_family_abroad,
personal_or_living_expenses,
protect_wealth,
purchase_goods_and_services,
receive_payment_for_freelancing,
receive_salary

Response

Result of a compliance field submission.

Result of a compliance field submission.

complianceFieldsComplete
boolean
required

Whether the user has now supplied every required field.

bridgeCustomerUpdated
boolean
required

Whether the fields were forwarded to the provider. False when the customer does not exist yet — they are included at creation instead.