Accounts are represented by account_ids, which are assigned to KYB’d (business) entities. If you
have an API Key and Secret, your application has its own account_id. You can also create
additional account_ids for your business clients.
account_id is associated with one or more custodial (type=internal) onchain wallets, which are represented by address_ids. An account_id may also be linked to a financial_institution_id to enable first-party fiat funding for mints and redemptions.
The account_id is used in the request URL across many Brale API endpoints to scope the request to a specific application or client.
To KYB and approve an account, we collect key details such as business name and EIN. For more information, see our Compliance Requirements. If additional details are required, we will notify you with the necessary steps to complete KYB.
Creating an account
You are required to pass in business information, controller information, and ultimate beneficial owner information. POSThttps://api.brale.xyz/accounts
Request
Presenting the Brale End-User Agreement
Partners must show the exact Brale End-User Agreement (EUA) to their end users before callingPOST /accounts and capture consent. The most recent version is hosted at https://brale.xyz/legal/end-user-agreement.
Accounts - Required vs. Optional Fields
| Field | Type | Required | Description |
|---|---|---|---|
business.name | string | Yes | Registered legal name |
business.website | string | Yes | Full URL incl. https:// |
business.phone | string | Yes | Accepts multiple common formats: digits only 8134688604, dashed 813-468-8604, or with country code 18134688604. Area code must be valid. |
business.address.street_line_1 | string | Yes | |
business.address.street_line_2 | string | No | Apt / Suite / Floor. |
business.address.city | string | Yes | |
business.address.state | string | Yes | Abbreviated format (NY, FL) |
business.address.zip | string | Yes | |
business_controller | object | Yes | One natural person who exercises control. API accepts U.S.-based controllers only; email support@brale.xyz if your controller is non-U.S. and we’ll process manually. |
beneficial_owners | array | Yes | Individual with ≥25% ownership |
tos_attestation | object | Yes |
Common Errors when creating Accounts
| HTTP Status | Code | Message | Potential Cause | Fix |
|---|---|---|---|---|
422 | Unprocessable Entity | Invalid format for business or controller information | Phone number area code is not valid | Include valid area code |
Account Status
Brale will review the Account and return astatus field denoting the customer’s KYB status. If the customer is in a pending status, you will need to wait for the customer to be verified before creating or linking addresses or bank accounts.
GET https://api.brale.xyz/accounts/:id
Response
Account Statuses
| Value | Description |
|---|---|
pending | KYB is in progress |
complete | KYB is completed and the account is approved |
rejected | The account’s KYB was rejected |
Using Account ID in every request
All resources in the Brale API (Addresses, Financial Institutions, Transfers, Automations, etc.) are scoped to specific accounts. Supply the ID in the path, never in the body.Every endpoint that contains
{account_id} must be called by including the account ID in the path. E.g. GET https://api.brale.xyz/accounts/2Js1YFqlfxgNqC2KTPEjrWIwKU7/addresses. Do not send the account ID in the body or query string.