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 NameDescription
1successIndicates whether the request was successful (true for success)
2responseCodeHTTP-like response code (e.g. 200 for success)
3responseMessageHuman-readable result message (e.g. Success)
4dataArray of country objects
4.1data[].nameFull display name of the country (e.g. Nigeria)
4.2data[].codeISO 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"
}

Did this page help you?