Quick Start

1. Create a Brale account

Visit https://app.brale.xyz/signup to sign up for a Brale account. You will need to complete KYB before you are approved for API access.

2. Create API credentials

Create an application on the Settings page in the Dashboard. Brale will make your API key available only once. Please save the key in a secure location.

3. Authenticate

Brale uses OAuth2 with the client_credentials grant type for secure access to our APIs. Sending a request to the Auth endpoint will return a bearer token to be used on all subsequent calls. The Authorization header uses Basic HTTP Authentication and requires encoding your client_id and client_secret into a Base64 format.

curl --request POST \
  --url https://auth.brale.xyz/oauth2/token \
  --header 'Authorization: Basic ${BASE_64_OF(client_id:client_secret)}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials

4. Onboard your first customer account

📘

To get started, it's recommended to direct your customer to https://app.brale.xyz/signup to onboard directly.

Create an Accounts object that represents your customer. Include the bearer token in the Authorization header of your API requests.

POST https://api.brale.xyz/accounts

{
	"business_name": "ABC Company Inc", 
	"ein": "111-11-1111", 
	"business_type": "Corporation", 
	"address": {
		"street_line_1": "123 Main St", 
		"street_line_2": "Apt C", 
		"city": "Des Moines", 
		"state": "Iowa", 
		"zip": "12345", 
		"country": "USA" 
	}, 
	"phone_number": "2134678902", 
	"email": "mark@example.com", 
	"website": "abccompany.com", 
	"ultimate_beneficial_owners": [{ 
		"name": "John Doe", 
		"ssn": "222-22-2222", 
		"address": {
			"street_line_1": "456 Elm St", 
			"street_line_2": "Suite 5", 
			"city": "Chicago", 
			"state": "Illinois", 
			"zip": "60601", 
			"country": "USA" 
		}
	}]
}

Brale will perform KYB on the Account and return a status field defining this customer’s KYB status.

{
  "id": "857644d7-9796-4c7f-ad92-52df8db9599b",
  "created_at": "2024-12-06T17:01:46.767Z",
  "updated_at": "2024-12-06T17:01:46.767Z",
  "name": "ABC Company Inc",
  "status": "pending"
}

5. Create customer credential

The Brale API allows you to generate a separate API credential for each of your end customers in the Brale dashboard. Create a credential associated with the Account you just created on the Settings page in the Dashboard.

When you perform a transaction on behalf of your customer, call our API using the credential associated with that customer’s account.

6. Create your first transfer

Use Transfers to initiate funds movement from fiat to stablecoins (onramp), stablecoins to fiat (offramp), or stablecoins to stablecoins.

Here’s an example of onramping USD to your own stablecoin (YSBC) via wire transfer.

POST https://api.brale.xyz/transfers

{
	"amount": "10000.00", 
	"source": {
		"value_type": "usd", 
		"transfer_type": "wire"
	}, 
	"destination": {
		"address_id": "string", 
		"value_type": "ysbc", 
		"transfer_type": "solana"
	}
}

Now that you've completed your first transfer, follow Guides to get a deeper understanding of how to build with Brale.