Extraction API
Introduction
The Extraction API is used to extract details from the Passport such as Name, Date of Issue, place of issue etc. Both front and back side images are mandatory for Passport Extraction.
How to call the API
You will need to login before sending the request. You are required to pass the access token received from the login call, as authorization header in the Extraction API request.
API Input Guidelines
For best results, please make sure the image you use fits tightly in camera view and is horizontally-aligned. Each image/pdf should be less than 2MB.
Though this engine supports extraction of images as well as pdf files, our test results indicate that there is much better accuracy and faster response time for image extraction. We would suggest you to pass only image file for better results. For pdf files extacrtion, you can use our pdf to image converter API and then pass the resulted image file in this extraction engine.Pdf to Image(JPG).
Sample Curl
curl --location --request POST 'https://signzy.tech/api/v2/patrons/<patron ID>/passportV2' \
--header 'Authorization: <token>' \
--header 'content-type: application/json' \
--data-raw '{
"task": "extraction",
"essentials": {
"images": [
".....upload front image....",
".....upload back image...."
]
}
}'Response Parameter
Parameter Name | Description |
|---|---|
essentials | Essential part of the request |
essentials.images | URL of images |
id | Unique user ID |
patronId | Unique PatronID |
task | The type of task performed - “extraction” |
result | It is the actual result of the API |
result.parentsGuardianName | Parents or guardian name of passport holder |
result.issueDate | Date of issue of passport |
result.expiryDate | Date of expiry of passport |
result.birthDate | Date of birth of the Passport holder |
result.name | Name of the passport holder |
result.country | Country to which passport holder belongs to |
result.nationality | Nationality of passport holder |
result.sex | Gender of passport holder |
result.address | Address of passport holder |
result.pincode | Area pincode corresponding to passport holder address |
result.passportNumber | Passport number of the passport |
result.fileNumber | File number corresponding to the passport issued |
result.placeOfBirth | Place of birth of Passport holder. |
result.placeOfIssue | Place of issue of the passport |
result.splitAddress | Address of passport holder |
result.splitAddress.district | District in which the address mentioned lies. |
result.splitAddress.state | State to which the mentioned address belongs. |
result.splitAddress.city | City mentioned in address |
result.splitAddress.pincode | Area pincode of address mentioned |
result.splitAddress.country | Country to which address belongs |
result.splitAddress.addressLine | Contains the first Line of address |
result.summary | Summary of OCR output for given input |
result.summary.number | Passport Number |
result.summary.name | Name of passport holder |
result.summary.dob | Date of birth of passport holder |
result.summary.address | Address of passport holder |
result.summary.splitAddress | Address of passport holder |
result.summary.splitAddress.district | District to which address belongs to |
result.summary.splitAddress.state | State to which address belongs |
result.summary.splitAddress.city | City mentioned in address |
result.summary.splitAddress.pincode | Area pincode of address mentioned |
result.summary.splitAddress.country | Country to whicn address belongs |
result.summary.splitAddress.addressLine | first line of address shown here |
result.summary.gender | Gender of Passport holder |
result.summary.guardianName | Guardian name of passport holder. |
result.summary.issueDate | Date of issue of passport holder |
result.summary.expiryDate | Date of expiry of passport |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].