Ctrl+K

Get address format information

get/api/accounts/v1/address

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.

Query Parameters

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

200 Response

One of
countries dictionary<string, string> required
Dictionary mapping ISO 3166-1 alpha-2 country codes to their full country names
Example: {"US":"United States of America","CA":"Canada","GB":"United Kingdom","DE":"Germany"}
string
Full country name

400 Response

errorName string required
error string required

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

404 Response

errorName string required
error string required

500 Response

errorName string required
error string required