This API is designed to extract and provide comprehensive information from images of official documents, such as passports. It uses advanced (OCR) technology to analyze the document's content and retrieve important details, including personal information, document attributes, and biometric data. The API processes the images efficiently and delivers structured, reliable data.
The key features of this API include extracting personal information such as name, date of birth, nationality, and gender, as well as interpreting MRZ, which contain encoded data for rapid verification. The MRZ data encompasses critical fields like document number, expiration date, and issuing country code. Additionally, the API offers images of the document's front page, portrait, and signature, enabling visual verification and inspection.
To use this endpoint you must specify a passport image in the parameter.
Passport Extractor - Endpoint Features
| Object | Description |
|---|---|
Request Body |
[Required] File Binary |
{"result":"1","subScans":[],"value":"UNITED STATES OF AMERICA\n* PASSPORT CARD *\nPassport Card no.\nC03005988\nNationality\nUSA\n***\nSurname\nTRAVELER\nEXEMPLAR\nGiven Names\nHAPPY\n3\n3\nDate of Birth\nM\n1 JAN 1981\nPlace of Birth\nNEW YORK. U.S.A.\nIssued On\n30 NOV 2009\nExpires On\n29 NOV 2019\n1-02781-0\n2\nM-6131821-07\nUNITED STATES DEPARTMENT OF STATE"}
curl --location 'https://zylalabs.com/api/5717/passport+data+extractor+api/10389/passport+extractor' \
--header 'Content-Type: application/json' \
--form 'image=@"FILE_PATH"'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
To use this API, users must enter the URL of an image.
The Passport Data Extractor API extracts detailed data from passport images, including personal information, MRZ, and document images, for verification and processing.
There are different plans suits everyone including a free trial for small amount of requests, but it’s rate is limit to prevent abuse of the service.
The API uses API keys for authentication. To access the API, include your API key in the request header. The API key is provided upon registration and should be kept secure.
2 requests per second in all plans.
The API returns structured data extracted from passport images, including personal information (name, date of birth, nationality, gender), MRZ details (document number, expiration date), and images of the document's front page, portrait, and signature.
Key fields in the response include "detected_text" for extracted information, "language_code" indicating the language of the text, and specific personal details like "Surname," "Given Names," "Date of Birth," and MRZ attributes.
The response data is organized in a JSON format, with extracted text in "detected_text" and metadata like "language_code." Each piece of personal information is clearly labeled, allowing for easy parsing and utilization.
The endpoint provides personal identification details, MRZ data for verification, and images of the passport's front page, portrait, and signature, facilitating both data extraction and visual verification.
Users can customize their requests by providing the URL of the passport image they wish to process. The API automatically analyzes the provided image to extract relevant data.
Typical use cases include identity verification for travel, onboarding processes in financial services, and automated document processing in government agencies, enhancing efficiency and accuracy.
Data accuracy is maintained through advanced OCR technology that analyzes document features and patterns. Continuous updates and improvements to the algorithm also help enhance extraction reliability.
If the API returns partial or empty results, users should verify the image quality and ensure the document is fully visible. Adjusting the image resolution or providing a clearer image may improve extraction outcomes.
To obtain your API key, you first need to sign in to your account and subscribe to the API you want to use. Once subscribed, go to your Profile, open the Subscription section, and select the specific API. Your API key will be available there and can be used to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
If you don’t cancel before the 7th day, your free trial will end automatically and your subscription will switch to a paid plan under the same plan you originally subscribed to, meaning you will be charged and gain access to the API calls included in that plan.
The free trial ends when you reach 50 API requests or after 7 days, whichever comes first.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost, so you can test our APIs without any commitment.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund
Service Level:
100%
Response Time:
678ms
Service Level:
100%
Response Time:
372ms
Service Level:
100%
Response Time:
2,732ms
Service Level:
100%
Response Time:
368ms
Service Level:
100%
Response Time:
516ms
Service Level:
100%
Response Time:
794ms
Service Level:
100%
Response Time:
1,812ms
Service Level:
100%
Response Time:
4,485ms
Service Level:
100%
Response Time:
1,110ms
Service Level:
100%
Response Time:
1,344ms