Verify Alien ID

Alien ID Verification

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

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
id*	String	Candidates alien id number
isSubjectConsent	Boolean	Indicate subject has given consent. Must be true

Alien Id Verification Sample Request

{
    "id":"111111111",
    "isSubjectConsent":true
}

Alien Id Verification Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "66ec6bb1d0bdbb9c4fce6122",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "firstName": "AMANI",
        "middleName": "DIEUDONNE",
        "lastName": "UWAYO",
        "fullName": "UWAYO AMANI DIEUDONNE",
        "image": null,
        "idType": "id",
        "nationality": "Alien",
        "dateOfBirth": "1992-11-19",
        "isConsent": true,
        "idNumber": "111111111",
        "businessId": "62b2e8b281442b03187f7896",
        "type": "keAlienId",
        "allValidationPassed": true,
        "gender": "female",
        "requestedAt": "2024-09-19T18:21:39.311Z",
        "requestedById": "62b2e8b381442b75857f7898",
        "country": "KE",
        "createdAt": "2024-09-19T18:21:39.670Z",
        "lastModifiedAt": "2024-09-19T18:21:39.670Z",
        "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": {}
}