Addresses

Update offchain address details for an account

Changed on

Updates a bank account (offchain address). Onchain addresses are not found by this endpoint. Requires the financial-institutions:write scope.

patch/accounts/{account_id}/addresses/offchain/{address_id}

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://auth.brale.xyz/oauth2/token
    Scopesfinancial-institutions:write

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

address_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Address ID

Request body

account_holder_type'individual' | 'business'

For bank (financial institution) addresses only. Whether the bank account belongs to an individual or a business. Can only be set while it is not set yet.

additional_transfer_typesstring[]
date_of_birthstring

For bank (financial institution) addresses only. Date of birth of an individual recipient (format: YYYY-MM-DD). Can only be set while it is not set yet, and cannot be sent when account_holder_type is business.

namestring nullable
status'active' | 'archived' nullable

Example request

{
  "additional_transfer_types": [
    "solana"
  ],
  "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"
  },
  "date_of_birth": "1990-01-31",
  "name": "Company External EVM Address"
}

Response

OK

account_holder_type'individual' | 'business' nullable

Whether the bank account belongs to an individual or a business. Null when not provided.

account_numberstring nullable

Masked account number showing only last 4 digits for security (format: ****1234). Full number never returned.

account_type'checking' | 'savings' nullable
createdstring date-time required

ISO-8601 timestamp that includes date and time

date_of_birthstring nullable

Masked date of birth of the recipient showing only the year (format: YYYY--). Full date never returned. Null when not provided.

idstring required

ID of the resource

last_updatedstring date_time

Last update timestamp

namestring nullable required
needs_updateboolean

Whether this FI needs Plaid reauthorization

ownerstring nullable

Beneficiary name for wire transfers (maps from POST request owner field)

ownership'self-owned' | 'customer-owned'

Ownership type of the financial institution

routingNumberstring required
status'active' | 'archived' required
transfer_typesstring[] nullable

Example response

{
  "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