Skip to main content
POST
/
accounts
/
{account_id}
/
plaid
/
link_token
Create Plaid link token
curl --request POST \
  --url https://api.brale.xyz/accounts/{account_id}/plaid/link_token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legal_name": "John Doe",
  "email_address": "user@example.com",
  "phone_number": "+1234567890",
  "date_of_birth": "1990-01-01"
}
'
{
  "link_token": "link-sandbox-123456789",
  "expiration": "2024-01-01T12:00:00Z",
  "callback_url": "https://customer.com/webhooks/plaid-updates"
}
This endpoint is step 1 of the Plaid-linked bank account flow for creating external off-chain bank addresses. The Plaid-linked path supports ach_debit, ach_credit, and rtp. This is the only path that enables ach_debit. Native mobile apps: If you are integrating Plaid Link in a native iOS or Android app, you must submit your iOS redirect URI or Android package name to Brale for whitelisting before mobile Plaid OAuth will work. See the ACH on-ramp guide for platform-specific setup details. Next step: After the user completes the Plaid Link flow, exchange the public_token using Register financial institution account via Plaid to create the address_id. For a full comparison of both external bank address creation paths, see External bank addresses. Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel.

Authorizations

Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Path Parameters

account_id
string
required

Body

application/json

User's legal name

Example:

"John Doe"

email_address
string

User's email address

Example:

"user@example.com"

phone_number
string

User's phone number

Example:

"+1234567890"

date_of_birth
string

User's date of birth

Example:

"1990-01-01"

Response

200 - application/json

OK

Plaid Link token

Example:

"link-sandbox-123456789"

expiration
string
required

ISO 8601 expiration

Example:

"2024-01-01T12:00:00Z"

callback_url
string
required

URL to POST the public token to after Plaid Link

Example:

"https://customer.com/webhooks/plaid-updates"