Lookup Ghana SSNIT ID

Verify a Ghanaian SSNIT (social security) number and fetch holder details from the SSNIT database.

Request

[GET]

{{baseUrl}}/api/v1/gh/kyc/ssnit

Header

Header	Type	Description
AppId	string	Create an app to get your app ID on dashboard here
Authorization	string	Private/secret key. Use <key> not Bearer <key>

Query parameter

Parameter	Type	Description	Required
id *	string	The Voter Number, Application ID, or National ID Number (NIN)	required
full_name *	string	The full name of the document holder	required
date_of_birth*	string	The date of birth of the document holder in the form yyyy-MM-DD	required

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

Response Fields

Field	Type	Description
entity	object	Contains the verification response data
entity.card_serial	string	SSNIT card serial number
entity.date_of_birth	string	Date of birth of the individual (yyyy-MM-dd)
entity.full_name	string	Full name of the individual
entity.gender	string	Gender of the individual
entity.id	string	SSNIT ID number
entity.is_date_of_birth_match	boolean	Whether the provided date of birth matches the record
entity.is_full_name_match	boolean	Whether the provided name matches the record
entity.picture	string	Base64-encoded photo of the individual