Countries
Look up supported countries and address field requirements.
GET
/api/v1/countriesDescription
Returns the platform country catalog with address validation metadata. Use is_state_required to determine whether the state field is required for a selected country in Recover and other address flows.
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| data.address_requirements.state | object | Describes when the state field is required |
| data.countries[].code | string | ISO country code |
| data.countries[].name | string | Country display name |
| data.countries[].is_state_required | boolean | When true, state must be provided for that country |
State-required countries
The API is authoritative. Each country in the response includes is_state_required. When true, the state field must be provided for that country. When false, requests may omit state.
Notes
- Recover endpoints such as Initiate Recovery and Bulk Upload validate state using this catalog.
- When state is required and omitted, the API returns HTTP 422 with State is required for the selected country.
Related Endpoints
Did this page help you?
Request
curl -X GET https://uat.unduit.com/api-exposed/api/v1/countries \
-H "Content-Type: application/json"Success Response (200)
{
"success": true,
"data": {
"address_requirements": {
"state": {
"field": "state",
"required_when": "country.is_state_required === true"
}
},
"countries": [
{
"code": "US",
"name": "United States",
"is_state_required": true
},
{
"code": "GB",
"name": "United Kingdom",
"is_state_required": false
}
]
}
}