---
title: "Get address format information"
method: GET
path: "/api/accounts/v1/address"
tags: ["Bank Accounts"]
---

# 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

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

## Response `200`

OK

- union
  - CountryListResponse — Response when requesting all available countries
    - `countries` object, required — Dictionary mapping ISO 3166-1 alpha-2 country codes to their full country names
  - CountryAddressFormatResponse — Response when requesting address format for a specific country
    - `rules` CountryAddress, required
      - `country` string, required
      - `address_line_1` union, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'text', required
          - `placeholder` string
          - `maxLength` number, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'dropdown', required
          - `placeholder` string
          - `options` object, required
      - `address_line_2` union, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'text', required
          - `placeholder` string
          - `maxLength` number, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'dropdown', required
          - `placeholder` string
          - `options` object, required
      - `city_locality` union
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'text', required
          - `placeholder` string
          - `maxLength` number, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'dropdown', required
          - `placeholder` string
          - `options` object, required
      - `state_province` union
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'text', required
          - `placeholder` string
          - `maxLength` number, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'dropdown', required
          - `placeholder` string
          - `options` object, required
      - `postal_code` union
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'text', required
          - `placeholder` string
          - `maxLength` number, required
        - object
          - `label` string, required
          - `required` boolean, required
          - `type` 'dropdown', required
          - `placeholder` string
          - `options` object, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)