Verify Identity Number

This section contains api endpoint to verify a kenyan identity number, as well as request and response samples

Identity Verification

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

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Candidates id number
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
idType*	Object	Candidates id type, this can be one of the following national-id and passport
metadata	Object	Metadata object. Any valid object can be passed here. It gets returned as is.

Identity Verification

This is used to verify that the Kenyan identity number provided exists in the database. It shows non-account information available for a given identity. The identity number can be for a Passport, National ID, Service ID, or Alien ID.

Identity Number Found Sample

This contains request and response samples of a valid and existing identity number and the owner's information

Identity Verification Sample Request

{
    "id": "1234567",
    "idType": "national-id",
    "isSubjectConsent": true
}

Identity Verification Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64eed6026b1a9b8f72c2925e",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "dateOfBirth": "1999-12-31T21:00:00Z",
        "identityType": "national-id",
        "isConsent": true,
        "idNumber": "1234567",
        "businessId": "628b38f03ae28a14f52d4bf7",
        "firstName": "John",
        "middleName": "M",
        "lastName": "Doe",
        "fullName": "John M Doe",
        "gender": "Male",
        "maritalStatus": "Married",
        "email": "[e-mail]",
        "homeTelephoneNumber": "[phone]",
        "mobileTelephoneNumber": "254723818284",
        "workTelephoneNumber": "040-3203308",
        "employmentName": "Teachers Service Commission.",
        "lastEmployment": "NotSpecified",
        "mainAddress": {
            "address": "NYAHURURU  KCC",
            "country": "KE",
            "town": "Nyahururu"
        },
        "secondaryAddress": {
            "address": "NAKURU-CENTRE",
            "country": "KE",
            "town": "NYAHURURU",
            "postalCode": "20300"
        },
        "contractSummary": {
            "closedContracts": "2",
            "openContracts": "10"
        },
        "inquiries": {
            "numberOfInquiriesLast12Months": "89",
            "numberOfInquiriesLast1Month": "6",
            "numberOfInquiriesLast24Months": "355",
            "numberOfInquiriesLast3Months": "12",
            "numberOfInquiriesLast6Months": "27"
        },
        "type": "keCreditInfo",
        "allValidationPassed": true,
        "requestedAt": "2023-08-30T05:39:15.781Z",
        "requestedById": "628b38f03ae28a5a122d4bf3",
        "country": "KE",
        "createdAt": "2023-08-30T05:39:15.974Z",
        "lastModifiedAt": "2023-08-30T05:39:15.974Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "628b38f03ae28a5a122d4bf3"
        }
    },
    "links": []
}

Not Found Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64db6940563aa72892176950",
        "parentId": null,
        "status": "not_found",
        "reason": "Person Not Found",
        "dataValidation": false,
        "selfieValidation": false,
        "dateOfBirth": null,
        "identityType": "national-id",
        "isConsent": true,
        "idNumber": "00000000",
        "businessId": "628b38f03ae28a14f52d4bf7",
        "email":null,
        "homeTelephoneNumber": null,
        "mobileTelephoneNumber": null,
        "workTelephoneNumber": null,
        "type": "keCreditInfoPhone",
        "allValidationPassed": true,
        "requestedAt": "2023-08-15T12:02:09.602Z",
        "requestedById": "628b38f03ae28a5a122d4bf3",
        "country": "KE",
        "createdAt": "2023-08-15T12:02:09.767Z",
        "lastModifiedAt": "2023-08-15T12:02:09.767Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "Onyeka",
            "lastName": "Ijeh",
            "middleName": "",
            "id": "628b38f13ae28a7b742d4bf9"
        }
    },
    "links": []
}

Error Response

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