Passport Data Extraction API

Passport Data Extraction API

This API will easily detect and extract data located at MRZ from any passport you pass to it.

API description

About the API:

The Machine-Readable Zone (MRZ) of an identity document is something that most people take little to no notice of. 

An MRZ code is two lines of text which includes the following data that is also displayed in the VIZ:

  • Document code
  • State code, or code of the government agency (organization) that issued the passport 
  • Full Name
  • Document number
  • Citizenship
  • Birthdate
  • Gender
  • Expiration date
  • Other data may also be included, at the discretion of the document’s issuing authority

 

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

This API will receive the image URL of the passport you want and it will deliver structured data from it like:

Confidence Score.

MRZ validity.

Expiration date.

Surname and First name. 

Gender.

Birth.

Nationality.  

 

What are the most common uses cases of this API?

 

Standardize your information: Receive standardized data to store it in your databases. 

Trip purposes: Be able to detect the nationality of any of the users and be able to send advice on what they would need to start their journey. Maybe some user from a determined country will need a VISA to enter another country, you could view it beforehand. 

MRZ Validations: Be able to detect if a given MRZ is invalid so the user could not move forward with an application. 

Data validation: Compare databases with the information given by the MRZ to verify someone's identity. Also, be able to determine if they are underage or not to allow them to use certain functions on your application. 

 

Are there any limitations to your plans?

Besides the number of API calls per month:

Pro Plan: One request per second. 

API Documentation

Endpoints


Extract Machine Readable Zone (MRZ) on passports

 



                                                                            
POST https://zylalabs.com/api/332/passport+data+extraction+api/267/get+passport+data
                                                                            
                                                                        

Get Passport Data - Endpoint Features
Object Description
url [Required] Passport image URL (PNG, JPG or PDF file < 4 Mo)
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"confidence":100,"mrz_valid":true,"filename":"https://answerdash-images.s3.amazonaws.com/1183/2163b3367a3c3d687ef68bba2b0b952c78f713e1/1528277944.perfect_20passport.jpg","expiration_date":"160131","number":"107185703","surname":"UNITED KINGDOM FIVE","names":["JODIE","PIPPA"],"gender":"F","birth":"850117","country":"GBR","nationality":"G3R","text":"P<GBRUNITED<KINGDOM<FIVE<<JODIE<PIPPA<<<<<<<\n107185703263R8501178F1601312<<<<<<<<<<<<<<02"}
                                                                                                                                                                                                                    
                                                                                                    

Get Passport Data - CODE SNIPPETS


curl --location --request POST 'https://zylalabs.com/api/332/passport+data+extraction+api/267/get+passport+data?url=https://answerdash-images.s3.amazonaws.com/1183/2163b3367a3c3d687ef68bba2b0b952c78f713e1/1528277944.perfect_20passport.jpg' --header 'Authorization: Bearer YOUR_API_KEY' 

    

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 Data Extraction 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 commitments. One click upgrade/downgrade or cancellation. No questions asked.

🚀 Enterprise
Starts at $10,000/Year

  • Custom Volume
  • Dedicated account manager
  • Service-level agreement (SLA)

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

Zyla API Hub is, in other words, an API MarketPlace. An all-in-one solution for your developing needs. You will be accessing our extended list of APIs with only your user. Also, you won't need to worry about storing API keys, only one API key for all our products is needed.

Prices are listed in USD. 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 with paying by card, just contact us at [email protected]

Sometimes depending on the bank's fraud protection settings, a bank will decline the validation charge we make when we attempt to be sure a card is valid. We recommend first contacting your bank to see if they are blocking our charges. If more help is needed, please contact [email protected] and our team will investigate further

Prices are based on a recurring monthly subscription depending on the plan selected — plus overage fees applied when a developer exceeds a plan’s quota limits. In this example, you'll see the base plan amount as well as a quota limit of API requests. Be sure to notice the overage fee because you will be charged for each additional request.

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.

Just go to the pricing page of that API and select the plan that you want to upgrade to. You will only be charged the full amount of that plan, but you will be enjoying the features that the plan offers right away.

Yes, absolutely. If you want to cancel your plan, simply go to your account and cancel on the Billing page. Upgrades, downgrades, and cancellations are immediate.

You can contact us through our chat channel to receive immediate assistance. We are always online from 9 am to 6 pm (GMT+1). If you reach us after that time, we will be in contact when we are back. Also you can contact us via email to [email protected]

 Service Level
100%
 Response Time
11,257ms

Useful links:


Category:


Tags:


Related APIs