Verify National ID

National ID Verification

POST {{baseurl}}/v2/api/identity/ke/national-id

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Candidates national id number
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
validations	Object	Validation object
data	Object	Validation data object
lastName	String	last name to compare against ID
firstName	String	first name to compare against ID
dateOfBirth	String	date of birth to compare against ID

National ID Verification Sample Request

{
    "id": "2383526090",
    "isSubjectConsent": true,
    "validations": {
        "data": {
            "lastName": "KWAMBOKA",
            "firstName": "OMISO",
            "dateOfBirth": "1995-12-30"s
        },
    }
}

National ID Verification Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "66ec6c0bb62925a49d7991f9",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "nationalId": "38039808",
        "fullName": "SILVERSTEIN MWANGANGI KYALO",
        "address": {
            "city": "Nairobi",
            "town": null,
            "lga": null,
            "state": null,
            "addressLine": "Langata"
        },
        "issuedDate": "2021-01-27T00:00:00.000Z",
        "expiredDate": "2024-09-02T00:00:00.000Z",
        "mobile": "254740364279",
        "kra": "A015194601C",
        "dateOfBirth": "10-Apr-00",
        "isConsent": true,
        "idNumber": "111111111",
        "businessId": "62b2e8b281442b03187f7896",
        "classOfLicense": "B",
        "interimNumber": "IDL-698600",
        "licenseNumber": "DL-1164090",
        "bloodGroup": "UNKNOWN",
        "email": "[email protected]",
        "smartDlDetails": {
            "hasSmartDl": "Waiting to Pay Interim",
            "smartDlBookingTestCenter": "146",
            "smartDLBookingStatus": "BOOKED",
            "smartDlBookingDate": "02-May-21",
            "smartDlBookingStartDate": "02-May-21"
        },
        "allValidationPassed": true,
        "gender": "male",
        "type": "keDriversLicense",
        "requestedAt": "2024-09-19T18:23:09.514Z",
        "requestedById": "62b2e8b381442b75857f7898",
        "country": "KE",
        "createdAt": "2024-09-19T18:23:10.018Z",
        "lastModifiedAt": "2024-09-19T18:23:10.018Z",
        "adverseMediaReport": null,
        "amlReport": null,
        "metadata": {},
        "requestedBy": {
            "firstName": "Abdulazeez",
            "lastName": "Shittu",
            "middleName": "",
            "id": "62b2e8b381442b75857f7898"
        }
    },
    "links": []
}

Error Response

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}