Verify Address Information

Address Information Verification

POST {{baseurl}}/v2/api/identity/ke/address

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Candidates identity number
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true
idtype*	String	Identity number type this can be one of the following national-id and passport

Address Information Verification

Address information verification retrieves the addressing information on a provided Kenyan National ID or Passport number.

Address Information Verification Sample Request (National ID)

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

Address Information Verification Sample Response (National ID)

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "64f843f1304e30c0c965dc2f",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "dateOfBirth": "1999-12-31",
        "identityType": "national-id",
        "isConsent": true,
        "idNumber": "1234567",
        "businessId": "62c2a4868d319373a6280152",
        "firstName": "Kangethe",
        "middleName": "Kariuki",
        "lastName": "Simon",
        "fullName": "Kangethe Kariuki  Simon",
        "gender": "Male",
        "maritalStatus": "Married",
        "mainAddress": {
            "address": "NYAHURURU  KCC",
            "country": "KE",
            "town": "Nyahururu"
        },
        "secondaryAddress": {
            "address": "NAKURU-CENTRE",
            "country": "KE",
            "town": "NYAHURURU",
            "postalCode": "20300"
        },
        "type": "keCreditInfoAddress",
        "allValidationPassed": true,
        "requestedAt": "2023-09-06T09:18:41.706Z",
        "requestedById": "62c2a4868d3193700828014e",
        "country": "KE",
        "createdAt": "2023-09-06T09:18:41.746Z",
        "lastModifiedAt": "2023-09-06T09:18:41.746Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "62c2a4868d3193700828014e"
        }
    },
    "links": []
}

Error Response

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