Ghana Card

Verify a customer's identity using their Ghana Card by the National Identification Authority.

{{baseUrl}}/v1/gh/identities/ghana-id/{idNumber}

Path Parameter

ParameterTypeDescription
IdNumber *
(REQUIRED)
stringGhana Card Identity Number

Request Body

POST ParameterTypeDescription
firstname
(REQUIRED)
stringFirst Name
lastname
(REQUIRED)
stringLast Name
middlename (OPTIONAL)stringMiddle Name
dob
(OPTIONAL)
dateStringDate Of Birth (YYYY-MM-DD)
phone
(OPTIONAL)
stringPhone Number
email
(OPTIONAL)
stringEmail Address
gender
(OPTIONAL)
stringGender

This endpoint will return all bio-data information captured. To conduct an actual test

Response Sample

{
    "id": 25111555,
    "applicant": {
        "firstname": "John",
        "lastname": "Doe"
    },
    "summary": {
        "ghana_id_check": {
            "status": "EXACT_MATCH",
            "fieldMatches": {
                "firstname": true,
                "lastname": true
            }
        }
    },
    "status": {
        "state": "complete",
        "status": "verified"
    },
    "ghana_id": {
        "nationalId": "GHA-123456789-1",
        "firstName": "John",
        "lastName": "Doe",
        "otherName": "Jack",
        "gender": "M",
        "dateOfBirth": "1990-01-01",
        "nationality": "Ghanian",
        "dateOfIssue": "1990-01-01",
        "dateOfExpiry": "2000-01-01",
        "phone": "+233554237337",
        "address": "GA-110-2223",
        "photo": ""
    }
}