Checking a used token's results

GET /token_status

The /token_status endpoint serves to retrieve the current results of a given token. You need to pass the token as a query parameter. Simply include token=your_token in the request to specify the token whom's status you want to check.

info

Remember to inlcude the X-API-AUTH header to your requests. Refer to API Authentication

Example Request

curl --location 'https://service-prod.metric.africa/api/identification/token_status?token=XXXXXXX' \
--header 'X-API-AUTH: abcdefghijklmnopqrstuvwxyz'

Success Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": {
        "token": "XXXXXXXX",
        "status": "SUCCESSFUL",
        "transactionnumber": "GH-STE-XXXXXXXXX-XXXXXX-XXXX"
    }
}

Failed Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": {
        "token": "XXXXXXXXX",
        "status": "FAILED",
        "transactionnumber": "GH-INP-XXXXXXXX-XXXXXXX-XXXXXX",
        "error": "Verification Unsuccesful"
    }
}