Sign in

v1

latestOpenAPI 3.0.32026-07-23152665.5 KB
Services

Get ID type availability status

Returns the current availability and success rate for a specific ID type in a given country, based on uptime data from the last hour.

Requires authentication via JWT token.

get/v3/services/id_status

Query parameters

countrystring required

ISO 3166-1 alpha-2 country code or full country name (e.g. "NG" or "Nigeria").

id_typestring required

The ID type code to check status for (e.g. "BVN", "NIN", "VOTER_ID").

Response

ID status retrieved successfully.

last_checkedstring date-time required

Timestamp of the most recent uptime check.

last_check_status'success' | 'failure' required

Whether the most recent check succeeded or failed.

last_hour_success_ratestring required

Aggregate success rate over the last hour as a percentage.

last_known_statusstring required

The raw status string from the most recent check (e.g. "online", "offline").

last_check_success_ratestring required

Success rate of the most recent individual check as a percentage.