The Passport Verification API provides a robust solution for validating passport details. By providing a passport ID, users can retrieve comprehensive passport information, ensuring accuracy and streamlining verification processes. This API offers a straightforward method to verify passport details, enabling users to automate the extraction and verification of passport data, reducing errors and improving the reliability of passport verification.
Verify Passport-MRZ
The "Verify Passport" 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/verify
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/verify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyXXXX' \
--data-raw '{
"type": 5,
"username": "XXX",
"passport_file_no":"XXXXXX",
"dob":"XXXX-XX-XX"
}'
Response:
If success-
{
"statusCode": 200,
"statusMsg": "Success",
"result": true,
"msg": "Valid Passport Number",
"data": {
"date_of_application": "XXXX",
"dob": "XXX",
"full_name": "XXXXX",
"client_id": "passport_XXXXXXXX",
"passport_number": "XXXXX",
"file_number": "XXXXXX"
}
}
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 |