List countries
Core API
- Concepts
- Authentication
- Countries
- Users
- KYC
- Capabilities
- Terms of Service
- Files
- Assets
- Accounts
- External Accounts
- Transactions
- Webhooks
Widgets API
- Payment
List countries
List countries supported by the platform.
GET
/
core
/
countries
Copy
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/countries \
--header 'Authorization: Bearer <token>'
Copy
{
"countries": [
{
"code": "GB",
"name": "United Kingdom",
"asset": "GBP",
"restrictions": [],
"subdivisions": [
{
"code": "GB-BAS",
"name": "Bath and North East Somerset",
"restrictions": []
},
{
"code": "GB-LND",
"name": "London, City of",
"restrictions": []
}
]
},
{
"code": "US",
"name": "United States of America",
"asset": "USD",
"restrictions": [],
"subdivisions": [
{
"code": "US-CA",
"name": "California",
"restrictions": []
},
{
"code": "US-NY",
"name": "New York",
"restrictions": [
{
"scope": "residence"
}
]
}
]
}
]
}
Authorizations
OAuth 2.0 authentication.
Response
200 - application/json
Countries list retrieved.
The unique code of the country.
The name of the country.
The national asset of the country.
The restrictions of the country.
The scope of the restriction.
Available options:
citizenship
, geolocation
, phone
, residence
The subdivisions of the country.
The unique code of the subdivision.
The name of the subdivision.
Copy
curl --request GET \
--url https://api.enterprise.sandbox.uphold.com/core/countries \
--header 'Authorization: Bearer <token>'
Copy
{
"countries": [
{
"code": "GB",
"name": "United Kingdom",
"asset": "GBP",
"restrictions": [],
"subdivisions": [
{
"code": "GB-BAS",
"name": "Bath and North East Somerset",
"restrictions": []
},
{
"code": "GB-LND",
"name": "London, City of",
"restrictions": []
}
]
},
{
"code": "US",
"name": "United States of America",
"asset": "USD",
"restrictions": [],
"subdivisions": [
{
"code": "US-CA",
"name": "California",
"restrictions": []
},
{
"code": "US-NY",
"name": "New York",
"restrictions": [
{
"scope": "residence"
}
]
}
]
}
]
}