This API is designed to extract and return complete data from images of official documents, such as passports. It leverages advanced Optical Character Recognition (OCR) technology to analyze document content and extract crucial information such as personal data, document characteristics and biometric data. The API is able to recognize and process images to deliver structured data in a consistent and reliable format.
Key features of this API include the extraction of personal data such as name, date of birth, nationality and gender, as well as the reading of machine readable zones (MRZ), which contain encoded information for quick verification. The MRZ data includes critical fields such as document number, expiration date, issuing country code, etc. The API also provides images of the front, portrait and signature of the document, allowing visual inspection and verification.
To use this endpoint you must indicate the URL of an image in the parameter.
Extract Passport Information - Endpoint Features
Object | Description |
---|---|
url |
[Required] Indicates a URL |
{"detected_text":"UNITED STATES OF AMERICA\nBE\nM-6131821-07\n* PASSPORT CARD *\nUSAUSA\nNationality\nUSA\nSurname\nPassport Card no.*\nC03005988\nTRAVELER EXEMPLAR\nGiven Names\nHAPPY\nSex\nDate of Birth\nM 1 JAN 1981\nPlace of Birth\nNEW YORK. U.S.A.\nIssued On\nExpires On\n30 NOV 2009 29 NOV 2019\n1-02781-0\nUNITED STATES DEPARTMENT OF STATE\nS\n40000 3Nnn+","language_code":"en"}
curl --location --request POST 'https://zylalabs.com/api/5650/passport+information+api/7359/extract+passport+information?url=https://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Passport_card.jpg/320px-Passport_card.jpg' --header 'Authorization: Bearer YOUR_API_KEY'
Header | Description |
---|---|
Authorization
|
[Required] Should be Bearer access_key . See "Your API Access Key" above when you are subscribed. |
No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.
To use this API, users must enter the URL of an image.
The Passport Information 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.
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.
Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the worldβs most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]
Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, look at the βX-Zyla-API-Calls-Monthly-Remainingβ header. For example, if your plan allows 1000 requests per month and you've used 100, this header will show 900.
To see the maximum number of API requests your plan allows, check the βX-Zyla-RateLimit-Limitβ header. For instance, if your plan includes 1000 requests per month, this header will display 1000.
The βX-Zyla-RateLimit-Resetβ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3600, it means 3600 seconds are left until the limit resets.
Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]
Service Level:
100%
Response Time:
239ms
Service Level:
97%
Response Time:
678ms
Service Level:
100%
Response Time:
214ms
Service Level:
100%
Response Time:
15,923ms
Service Level:
100%
Response Time:
221ms
Service Level:
100%
Response Time:
2,715ms
Service Level:
100%
Response Time:
266ms
Service Level:
100%
Response Time:
299ms
Service Level:
100%
Response Time:
755ms
Service Level:
100%
Response Time:
139ms
Service Level:
100%
Response Time:
2,018ms
Service Level:
100%
Response Time:
599ms
Service Level:
100%
Response Time:
733ms
Service Level:
100%
Response Time:
2,110ms
Service Level:
100%
Response Time:
1,574ms
Service Level:
100%
Response Time:
1,187ms
Service Level:
100%
Response Time:
1,451ms