Social Security & National Insurance Trust (SSNIT) Verification

SSNIT Lookup API

To perform verification on a Social Security and National Insurance Trust (SSNIT), make a POST request to the following endpoint;

https://api.korapay.com/merchant/api/v1/identities/gh/ssnit

Data Validation for SSNIT

Data validation for SSNIT enables you to verify an SSNIT and validate the information in the government database against the data parameters you provided when the verification request was made. You can validate the first_name, last_name, and date_of_birth by passing this information in the request body to get a true or false response on whether they match the information in the database. Use the same endpoint above to make this request.

Facial Matching for SSNIT

Facial matching for SSNIT enables you to compare the SSNIT holder’s image in the government database against the image provided when the verification request was made. A confidence score of how well the images match will be returned. Use the same endpoint above to make this request.


The request body should have the following parameters:

{
   "id": "C987464748977",
   "verification_consent": true
}
{
   "id": "C987464748977",
   "verification_consent": true,
   "validation": {
       "first_name": "John",
       "last_name": "Doe",
       "date_of_birth": "1988-04-04"
   }
}
{
   "id": "C987464748977",
   "verification_consent": true,
   "validation": {
       "first_name": "John",
       "last_name": "Doe",
       "date_of_birth": "1988-04-04",
       "selfie": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ"
   }
}

The fields in this request include:

FieldData TypeDescription
idStringRequired - the ID number
verification_consentBooleanRequired - this indicates that subject has given consent to perform this verification. This must be true for the check to be performed.
validation.first_nameStringOptional (required for data matching) - the first name of the ID holder to be compared with ID information in the government database.
validation.last_nameStringOptional (required for data matching) - the last name of the ID holder to be compared with ID information in the government database.
validation.date_of_birthStringOptional (required for data matching) - the date of birth of the ID holder to be compared with ID information in the government database.
validation.selfieStringOptional (required for facial matching) - the selfie/photo of the ID holder to be compared with ID information in the government database.

The response to this request would look like this:

{
   "status": true,
   "message": "GH SSNIT verified successfully",
   "data": {
       "reference": "VR-weQIx1ia6xYcn1FPl",
       "id": "C987464748977",
       "id_type": "gh_ssnit",
       "first_name": "Kwame",
       "last_name": "Asante",
       "middle_name": null,
       "full_name": "Kwame Asante",
       "date_of_birth": "1985-11-12",
       "card_serial": "00000012447866",
       "nationality": "GHANAIAN",
       "fss_no": "C987464748977",
       "gender": "male",
       "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTE",
       "validation": {
           "first_name": {
               "value": "Viola",
               "match": false
           },
           "last_name": {
               "value": "doe",
               "match": false
           },
           "date_of_birth": {
               "value": "1988-10-16",
               "match": false
           },
           "selfie": {
               "value": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA",
               "match": true,
               "confidence_rating": 94
           }
       },
       "requested_by": "API User"
   }
}