BRbrale
Addresses

Update address details for an account

Changed on
patch/accounts/{account_id}/addresses/{address_id}

Request

  • Base URL
    https://api.brale.xyz
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.brale.xyz/oauth2/token scopes: addresses: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

OR

Example response

{
  "address": "0xb518d4d6221d9a41d23d71cbce8e106e7aab8f9b",
  "created": "2020-01-01T12:00:00Z",
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC",
  "name": "Company External EVM Address",
  "transfer_types": [
    "solana"
  ]
}

Changes

  • 3378b8f911e0Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

  • 5648b7f3a014Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status