Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Bank Accounts

Get address format information

This endpoint serves two purposes:

  1. When called without a countryCode, it returns a list of all supported countries with their codes and full names
  2. When called with a specific countryCode, it returns the required address fields and format for that country

This information is used to dynamically build address collection forms with the appropriate fields for each country.

get/api/accounts/v1/address

Query parameters

countryCodestring

Optional ISO 3166-1 alpha-2 country code. If not provided, all supported countries will be returned.

Response

OK

OR

Example response

{
  "countries": {
    "US": "United States of America",
    "CA": "Canada",
    "GB": "United Kingdom",
    "DE": "Germany"
  }
}