Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.uphold.com/llms.txt

Use this file to discover all available pages before exploring further.

The countries group of endpoints allows you to retrieve information about the countries supported by the platform.

​
Country shape

A country has the following shape: 
{
  "country": {
    "code": "GB",
    "name": "United Kingdom",
    "asset": "GBP",
    "restrictions": [],
    "subdivisions": [
      {
        "code": "GB-ABC",
        "name": "Armagh, Banbridge and Craigavon",
        "restrictions": []
      },
      {
        "code": "GB-ABD",
        "name": "Aberdeenshire",
        "restrictions": []
      },
      {
        "code": "GB-ABE",
        "name": "Aberdeen City",
        "restrictions": []
      },
      {
        "code": "GB-AGB",
        "name": "Argyll and Bute",
        "restrictions": []
      },
      {
        "code": "GB-AGY",
        "name": "Isle of Anglesey",
        "restrictions": []
      },
      // ...
    ]
  }
}
Country and subdivision codes follow the ISO 3166 standard, more specifically, the two letter codes for country codes.

​
Restrictions

Countries and their subdivisions are subject to restrictions that may affect the availability of services, which are exposed through the API. Here’s a list of different restrictions that may apply:
  • residence - Users whose official residence belongs to a country or subdivision with this restriction are not allowed.
  • citizenship - Users whose citizenship belongs to a country with this restriction are not allowed.
  • geolocation - Users accessing the platform from a country with this restriction are not allowed (inferred from X-Uphold-User-Ip and X-Uphold-User-Country headers).
  • phone - Phone numbers belonging to a country with this restriction are not allowed.