Addresses
List offchain addresses for account
Changed onReturns the bank accounts (offchain addresses) associated with your account. Requires the financial-institutions:read scope.
get/accounts/{account_id}/addresses/offchain
Request
- Base URLhttps://api.brale.xyz
- AuthOAuth 2Client credentialsToken URLhttps://auth.brale.xyz/oauth2/tokenScopesfinancial-institutions:read
Path parameters
account_idstring required
ID of the resource
Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC
Account ID
Query parameters
transfer_typestring
Example:ach_credit
Filter by transfer type (can be specified multiple times for OR logic)
Pagination parameters. page[size] defaults to 25 and may not exceed 100.
Response
OK
Example response
{
"addresses": [
{
"account_holder_type": "business",
"account_number": "****1234",
"account_type": "checking",
"bank_address": {
"city": "Springfield",
"country": "US",
"street_line_1": "100 Example St.",
"street_line_2": "Suite 500",
"zip": "90001"
},
"beneficiary_address": {
"city": "Springfield",
"country": "US",
"street_line_1": "100 Example St.",
"street_line_2": "Suite 500",
"zip": "90001"
},
"created": "2020-01-01T12:00:00Z",
"date_of_birth": "1990-**-**",
"id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC",
"last_updated": "2024-01-15T10:30:00Z",
"name": "First Last Bank",
"owner": "Jane Doe",
"ownership": "customer-owned",
"routingNumber": "123456789",
"transfer_types": [
"ach_debit"
]
}
]
}Changes
- info
endpoint added
- info