v1

latestOpenAPI 3.1.02026-07-2611041.1 KB

Ghana Card

Verify a customer's identity using their Ghana card identity Number. For more context

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

Path parameters

idNumberstring required

Individual's Ghana card Number

Request body

firstnamestring required

First Name

lastnamestring required

Last Name

dobstring

Date of birth (YYYY-MM-DD)

phonestring

Phone Number

emailstring

Email Address

genderstring

Gender

Response

200

idinteger

Example response

{
  "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"
  }
}