Request

[GET]
{{baseUrl}}/api/v1/gh/kyc/ssnit
HeaderTypeDescription
AppIdstringyou would need to create an app to get your app ID
Authorizationstringpublic secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Query parameter

KeyTypeDescription
id *stringThe Voter Number, Application ID, or National ID Number (NIN)required
full_name *stringThe full name of the document holderrequired
date_of_birth*stringThe date of birth of the document holder in the form yyyy-MM-DDrequired

Sample response

Response
{
  "entity": {
    "card_serial": "R1970200019702",
    "date_of_birth": "1980-02-03",
    "full_name": "John Doe",
    "gender": "MALE",
    "id": "C000000000000",
    "is_date_of_birth_match": true,
    "is_full_name_match": true,
    "picture": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYA"
  }
}