GET

Get address format information

This endpoint serves two purposes:

When called without a countryCode, it returns a list of all supported countries with their codes and full names
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 Params

countryCode string

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

Responses

200

Response Body

ONE OF

countries map of strings required

Dictionary mapping ISO 3166-1 alpha-2 country codes to their full country names
countries object
- <key> string
  
  Full country name

rules object required
rules object
- country string required
  
  at least 1 characters
- address_line_1 object required
  ONE OF
  label string required
  
  at least 1 characters
  
  required boolean required
  
  placeholder string
  
  at least 1 characters
  
  maxLength number required
  
  type string enum required
  
  text
  label string required
  
  at least 1 characters
  
  required boolean required
  
  placeholder string
  
  at least 1 characters
  
  options map of strings required
  
  options object
  
  <key> string
  
  type string enum required
  
  dropdown
- address_line_2 object required
  address_line_2 object
  - Same shape as AddressOptions.
- city_locality object
  city_locality object
  - Same shape as AddressOptions.
- state_province object
  state_province object
  - Same shape as AddressOptions.
- postal_code object
  postal_code object
  - Same shape as AddressOptions.

400

Bad Request

Response Body

object

errorName string required
error string required

401

Unauthorized

Response Body

object

errorName string required
error string required

403

Forbidden

Response Body

object

errorName string required
error string required

404

Not Found

Response Body

object

errorName string required
error string required

500

Internal Server Error

Response Body

object

errorName string required
error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/accounts/v1/address&countryCode=string' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/accounts/v1/address&countryCode=string'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/accounts/v1/address&countryCode=string") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/accounts/v1/address&countryCode=string', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/accounts/v1/address&countryCode=string" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "rules": { "address_line_1": { "label": "Street Address", "maxLength": 100, "required": true, "type": "text" }, "city_locality": { "label": "City", "maxLength": 50, "required": true, "type": "text" }, "country": "US" } }