The Passport Machine-Readable Zone Verification API offers a robust solution for validating the machine-readable zone (MRZ) of passports. By utilizing this API, users can verify the integrity and accuracy of the MRZ data on passports, ensuring compliance and enhancing the efficiency of passport verification processes. This API provides a seamless method to perform MRZ validation, enabling users to automate the extraction and verification of data from passport MRZ, reducing errors and improving the reliability of passport verification.
Verify Passport-MRZ
The "Verify Passport-MRZ" API enables authentication by sending a POST request with username and password, securing access through a generated bearer token for subsequent authorized requests.
Method: POST
URL : https://prod.crimescan.ai/v1/verifyApi/passport_mrz
Function: Verify Passport
Parameters : type,username, passport_file_no, dob
Output Type : JSON
fields | Description | Required/Optional |
---|---|---|
type | Internal Purpose Only | Required |
username | UserName | Required |
passport_file_no | Passport_File_Number | Required |
dob | Date-Of-Birth | Required |
Example:
curl --location --request POST '\
https://prod.crimescan.ai/v1/verifyApi/passport_mrz' \
--header 'Authorization: Bearer eyXXX \
--form 'file=@/file-path/file_img.jpg' \
--form 'username=XXX' \
--form 'type=16'
Response:
If success-
{
"statusCode": 200,
"statusMsg": "Success",
"result": true,
"msg": "Valid Passport",
"data": {
"file_num": null,
"old_place_of_issue": null,
"mother": null,
"old_passport_num": null,
"given_name": "XXXX",
"country_code": “XXX",
"doi": "XXX",
"nationality": "XXXXX",
"surname": "XXXXX",
"mrz_line_1": "XXXXXXX",
"pin": null,
"doe": "XXXXX",
"old_doi": null,
"father": null,
"dob": "XXX",
"client_id": "XXXXXX",
"mrz_line_2": "XXXXXXX",
"place_of_issue": "XXXX",
"spouse": null,
"type_of_passport": "P",
"passport_validity": true,
"passport_num": "XXXXX",
"additional_check": [],
"place_of_birth": "XXXXXX",
"gender": "F",
"address": null
}
}
If file exceeds 5MB-
{
"statusCode": 412,
"statusMsg": "Failed",
"msg": "File size must not exceed 5MB!! Please upload file within 5MB"
}
If api key has been expired-
{
"statusCode": 401
"statusMsg": "Failed",
"msg": "Unauthorized access!"
}
If username is missing:
{
"statusCode": 401,
"statusMsg": "Failed",
"msg": "Username is missing!"
}
If username is invalid :
{
"statusCode": 401,
"statusMsg": "Failed",
"msg": "Username is invalid!"
}
If passport is missing:
{
"statusCode": 400,
"statusMsg": "Failed",
"result": false,
"msg": "Passport Is missing"
}
HTTP Status Codes:
HTTP CODE | Explanation |
---|---|
200 | Ok |
400 | Incorrect Input |
401 | Authentication Failed |
412 | File Size Error |