Passport OCR API

The Passport OCR API simplifies the process of retrieving passport details by efficiently identifying and extracting information from Machine Readable Zones (MRZ) found on passports. With this API, users can effortlessly locate and extract essential data from passports, streamlining various identification and verification processes.

About the API:

The Passport OCR API is a powerful tool designed to streamline the process of retrieving passport information. With its advanced functionality, this API offers a seamless solution for easily locating and extracting essential data from passports, specifically focusing on the Machine Readable Zone (MRZ).

Passports contain a wealth of valuable information, including the holder's personal details, travel history, and document expiration dates. However, manually extracting this information can be time-consuming and error-prone. The Passport OCR API solves this problem by automating the extraction process, allowing users to retrieve accurate and reliable passport data with minimal effort.

The key feature of this API is its ability to extract information from the MRZ on passports. The MRZ is a section of the passport that contains essential details in a standardized format, including the passport holder's name, nationality, date of birth, passport number, and other relevant information. By leveraging advanced Optical Character Recognition (OCR) technology, the API can accurately identify and extract the data from the MRZ, eliminating the need for manual data entry.

Integrating the Passport OCR API into applications, websites, or systems is straightforward, thanks to its well-documented and user-friendly interface. Developers can easily make HTTP requests to the API, passing the passport image or scan as input. The API then processes the image, performs the OCR analysis, and returns the extracted passport information in a structured format, such as JSON or XML.

The benefits of using the Passport OCR API are significant. It not only saves time and effort but also enhances accuracy and efficiency in handling passport-related tasks. This API finds applications in various industries and scenarios, such as airport immigration, hotel check-ins, visa processing, and border control. By automating the passport information extraction process, businesses and organizations can improve customer experiences, reduce errors, and increase productivity.

Furthermore, the Passport OCR API adheres to strict data privacy and security protocols. It ensures that sensitive passport information is handled with utmost care and remains confidential. By leveraging state-of-the-art encryption techniques and secure data transmission protocols, the API provides a robust and secure solution for handling passport data.

In conclusion, the Passport OCR API offers a seamless and efficient way to find and extract passport information. Its ability to accurately process the MRZ on passports simplifies identification and verification processes, saving time and improving accuracy. With its user-friendly integration process and robust security measures, this API is a valuable tool for businesses, government agencies, and any application that deals with passport-related data.

 

What your API receives and what your API provides (input/output)?

Upload the passport image and receive the data in a structured JSON response. 

 

What are the most common uses cases of this API?

  1. Airport Immigration: The Passport OCR API can be integrated into airport immigration systems to automate the extraction of passport information from travelers. By quickly scanning and extracting data from the MRZ, immigration officers can expedite the processing of passports, reducing waiting times and improving overall efficiency.

  2. Hotel Check-Ins: Hotels can utilize the Passport OCR API during the check-in process to streamline guest registration. By scanning the passport and extracting relevant information, such as the guest's name, nationality, and passport number, hotels can automate data entry, ensuring accuracy and saving time for both guests and staff.

  3. Visa Processing: Embassies and consulates can integrate the Passport OCR API into their visa processing systems. This enables the automated extraction of passport information from visa applications, simplifying the verification process and reducing manual data entry errors. It helps expedite visa processing and enhances the overall efficiency of the application review.

  4. Border Control: Government agencies responsible for border control can benefit from the Passport OCR API to automate the identification and verification of travelers. By integrating the API into border control systems, passport information can be quickly extracted from the MRZ, facilitating efficient and accurate identity checks at entry or exit points.

  5. Travel Document Management: Travel agencies, online travel platforms, or booking systems can integrate the Passport OCR API to simplify the management of travel documents. By automatically extracting passport information, these platforms can streamline the process of capturing and storing essential details, ensuring accurate records for bookings, visa applications, or other travel-related services.

  6. Identity Verification for Financial Services: Financial institutions, such as banks or fintech companies, can leverage the Passport OCR API to enhance their identity verification processes. When opening new accounts or conducting Know Your Customer (KYC) procedures, the API can extract relevant passport information, enabling seamless and efficient verification of customer identities, reducing fraud risks, and ensuring regulatory compliance.

These are just a few examples of the wide range of use cases for the Passport OCR API. Its ability to easily find and extract passport information from the MRZ opens up possibilities for automation, accuracy, and efficiency in various industries and applications that deal with passport-related data.

 

Are there any limitations to your plans?

Besides the number of API calls, there are no other limitations.

API Documentation

Endpoints


Extract Machine Readable Zone (MRZ) on passports

Passport image (PNG, JPG or PDF file < 4 Mo)

 


                                                                            
POST https://zylalabs.com/api/2024/passport+ocr+api/1801/get+data
                                                                            
                                                                        

Get Data - Endpoint Features

Object Description
Request Body [Required] File Binary
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"confidence":100,"mrz_valid":true,"filename":"AhK782I9DyAsG3ng4gZoIWQ8ej1ERjzQpXRC4Lw4.png","expiration_date":"240520","number":"E17060805","surname":"ZHONG","names":["HINGYONG"],"gender":"H","birth":"770321","country":"CHN","nationality":"CHN","text":"POCHNZHONG<<HINGYONG<<<<<<<<<<<<<<<<<<<<<<<<\nE170608057CHN7703218H2405207NGNDHDPLNDHCA990"}
                                                                                                                                                                                                                    
                                                                                                    

Get Data - CODE SNIPPETS


    curl --location 'https://zylalabs.com/api/2024/passport+ocr+api/1801/get+data' \
    --header 'Content-Type: application/json' \ 
    --form 'image=@"FILE_PATH"'


API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Passport OCR API REST API, simply include your bearer token in the Authorization header.
Headers
Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

πŸš€ Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Customer favorite features

  • βœ”οΈŽ Only Pay for Successful Requests
  • βœ”οΈŽ Free 7-Day Trial
  • βœ”οΈŽ Multi-Language Support
  • βœ”οΈŽ One API Key, All APIs.
  • βœ”οΈŽ Intuitive Dashboard
  • βœ”οΈŽ Comprehensive Error Handling
  • βœ”οΈŽ Developer-Friendly Docs
  • βœ”οΈŽ Postman Integration
  • βœ”οΈŽ Secure HTTPS Connections
  • βœ”οΈŽ Reliable Uptime

Passport OCR API FAQs

The Passport OCR API returns structured data extracted from the Machine Readable Zone (MRZ) of a passport. This includes fields such as the passport holder's name, nationality, date of birth, passport number, gender, and expiration date.

Key fields in the response include "surname," "names," "number" (passport number), "country," "nationality," "birth" (date of birth), "gender," "expiration_date," and "mrz_valid" (indicating if the MRZ is valid).

The response data is organized in a JSON format, with each key representing a specific piece of information extracted from the passport. For example, "names" is an array containing the first names, while "surname" holds the last name.

The API extracts various types of information from the MRZ, including personal details like the holder's name, nationality, date of birth, passport number, gender, and expiration date, facilitating identification and verification processes.

Users can customize their requests by uploading passport images in supported formats (PNG, JPG, PDF) under 4 MB. The API processes the provided image and returns the extracted data based on the content of the MRZ.

Standard data patterns include fields returning "n/a" when information is not available or valid. For example, if the MRZ is not valid, "mrz_valid" will be false, and other fields may also return "n/a" indicating missing data.

Data accuracy is maintained through advanced Optical Character Recognition (OCR) technology that accurately reads the MRZ. The API also implements quality checks to ensure the extracted data is reliable and valid.

Typical use cases include airport immigration processing, hotel check-ins, visa application verification, border control identity checks, and identity verification for financial services, enhancing efficiency and accuracy in these processes.

General FAQs

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 hello@zylalabs.com

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 hello@zylalabs.com

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, refer to the β€˜X-Zyla-API-Calls-Monthly-Remaining’ field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.

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 3,600, it means 3,600 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 hello@zylalabs.com

To give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.

Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.


Related APIs