Fetch Supported Countries
Fetch Countries
This endpoint returns the full list of countries supported by the platform, each with its display name and ISO 3166-1 alpha-2 country code. The country code is used when creating institutions or filtering institution records by country.
GET {{host}}/api/v1/institutions/countries
Response Message Field Description
| # | Field Name | Description |
|---|---|---|
| 1 | success | Indicates whether the request was successful (true for success) |
| 2 | responseCode | HTTP-like response code (e.g. 200 for success) |
| 3 | responseMessage | Human-readable result message (e.g. Success) |
| 4 | data | Array of country objects |
| 4.1 | data[].name | Full display name of the country (e.g. Nigeria) |
| 4.2 | data[].code | ISO 3166-1 alpha-2 country code (e.g. NG) |
Sample Response (Success)
{
"success": true,
"responseCode": "200",
"responseMessage": "Success",
"data": [
{
"name": "Nigeria",
"code": "NG"
},
{
"name": "Ghana",
"code": "GH"
},
{
"name": "United States",
"code": "US"
}
]
}Sample Response (Failure)
{
"success": false,
"responseCode": "500",
"responseMessage": "An unexpected error occurred"
}Updated about 11 hours ago
Did this page help you?
