Verify International Passport

Passport Verification

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

Headers

Request Body

Passport Verification

Passport verification is used to verify that a provided Kenyan International Passport number exists in the database. It shows the full information of the Passport holder;

{
    "id": "AK1367466",
    "metadata": {
        "requestId": "1209348756"
},
    "isSubjectConsent": true
}
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "62b511caf1d35a61f7ba4de6",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "firstName": "KARBOH",
        "middleName": null,
        "lastName": "ZEBOCK",
        "fullName": "KARBOH ZEBOCK",
        "image": null,
        "nationality": "KENYAN",
        "dateOfBirth": null,
        "isConsent": true,
        "idNumber": "AK0167656",
        "businessId": "6222a5ea3e7a41c29c030fac",
        "type": "kePassport",
        "gender": "male",
        "requestedAt": "2022-06-24T01:22:18.710Z",
        "requestedById": "6222a5ea3e7a41c29c030fad",
        "country": "KE",
        "createdAt": "2022-06-24T01:22:18.728Z",
        "lastModifiedAt": "2022-06-24T01:22:18.728Z",
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222a5ea3e7a41c29c030fad"
        }
    },
    "links": []
}

Passport Facial Matching

Passport Facial Matching is used to verify that a Passport is valid and also that image provided matches the image in the database. This includes a confidence score of the facial matching.

{
    "id": "AK0167656",
    "isSubjectConsent": true,
    "validations": {
        "selfie": {
            "image": "https://cdn.youverify.co/1627394241627-dvahka4o4vDxfvQUJgZFo.jpg"
        }
    }
}
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "62b511faf1d35a9100ba4dea",
        "validations": {
            "selfie": {
                "selfieVerification": {
                    "confidenceLevel": -1,
                    "threshold": 80,
                    "match": false,
                    "image": null
                }
            },
            "validationMessages": "No date of birth from data source, No Photo from data source"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": true,
        "firstName": "KOECH",
        "middleName": null,
        "lastName": "ZADDOCK",
        "fullName": "KOECH ZADDOCK",
        "image": null,
        "nationality": "KENYAN",
        "dateOfBirth": null,
        "isConsent": true,
        "idNumber": "AK0167656",
        "businessId": "6222a5ea3e7a41c29c030fac",
        "type": "kePassport",
        "gender": "male",
        "requestedAt": "2022-06-24T01:23:07.013Z",
        "requestedById": "6222a5ea3e7a41c29c030fad",
        "country": "KE",
        "createdAt": "2022-06-24T01:23:07.030Z",
        "lastModifiedAt": "2022-06-24T01:23:07.030Z",
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222a5ea3e7a41c29c030fad"
        }
    },
    "links": []
}

Passport Validation

Passport Validation is used to verify a Passport and compare given data parameters against the data present in the government database. For example, a first name and last name can be provided and this will validate as true or false as to whether it matches with the names in the database or not.

{
    "id": "AK0167656",
    "isSubjectConsent": true,
    "validations": {
        "data": {
            "lastName": "ZADDOCK",
            "firstName": "KOECH",
            "dateOfBirth": "1980-09-08"
        }
    }
}
{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "62b5120bf1d35a1c73ba4dee",
        "validations": {
            "data": {
                "lastName": {
                    "validated": true,
                    "value": "ZADDOCK"
                },
                "firstName": {
                    "validated": true,
                    "value": "KOECH"
                }
            },
            "validationMessages": "No date of birth from data source, No Photo from data source"
        },
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": true,
        "selfieValidation": false,
        "firstName": "KOECH",
        "middleName": null,
        "lastName": "ZADDOCK",
        "fullName": "KOECH ZADDOCK",
        "image": null,
        "nationality": "KENYAN",
        "dateOfBirth": null,
        "isConsent": true,
        "idNumber": "AK0167656",
        "businessId": "6222a5ea3e7a41c29c030fac",
        "type": "kePassport",
        "gender": "male",
        "requestedAt": "2022-06-24T01:23:23.431Z",
        "requestedById": "6222a5ea3e7a41c29c030fad",
        "country": "KE",
        "createdAt": "2022-06-24T01:23:23.443Z",
        "lastModifiedAt": "2022-06-24T01:23:23.443Z",
        "requestedBy": {
            "firstName": "API",
            "lastName": "User",
            "middleName": "",
            "id": "6222a5ea3e7a41c29c030fad"
        }
    },
    "links": []
}

Passport Full Sample Request

This is a sample request that contains all the parameters as described above, all in one call.

{
    "id": "AK0167656",
    "metadata": {
        "requestId": "1209348756"
},
    "isSubjectConsent": true,
    "validations": {
        "data": {
            "lastName": "ZADDOCK",
            "firstName": "KOECH",
            "dateOfBirth": "1980-09-08"
        },
        "selfie": {
            "image": "https://cdn.youverify.co/1627394241627-dvahka4o4vDxfvQUJgZFo.jpg"
        }
    }
}
{
        "success": true,
        "statusCode": 200,
        "message": "success",
        "data": {
            "id": "62b09202cb518575d6b38d9f",
            "validations": {
                "data": {
                    "lastName": {
                        "validated": true,
                        "value": "ZADDOCK"
                    },
                    "firstName": {
                        "validated": true,
                        "value": "KOECH"
                    }
                },
                "selfie": {
                    "selfieVerification": {
                        "confidenceLevel": -1,
                        "threshold": 80,
                        "match": false,
                        "image": null
                    }
                },
                "validationMessages": "No date of birth from data source, No Photo from data source"
            },
            "parentId": null,
            "status": "found",
            "reason": null,
            "dataValidation": true,
            "selfieValidation": true,
            "firstName": "KOECH",
            "middleName": null,
            "lastName": "ZADDOCK",
            "fullName": "KOECH ZADDOCK",
            "image": null,
            "nationality": "KENYAN",
            "dateOfBirth": null,
            "isConsent": true,
            "idNumber": "AK0167656",
            "businessId": "61d880f1e8e15aaf24558f1a",
            "type": "kePassport",
            "gender": "male",
            "requestedAt": "2022-06-20T15:28:02.972Z",
            "requestedById": "61d880f2e8e15aaf24558f9b",
            "country": "KE",
            "createdAt": "2022-06-20T15:28:03.125Z",
            "lastModifiedAt": "2022-06-20T15:28:03.125Z",
            "requestedBy": {
                "firstName": "Famous",
                "lastName": "Ehichioya",
                "middleName": "Prior",
                "id": "61d880f2e8e15aaf24558f9b"
            }
        },
        "links": []
    }
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}

Last updated