About the API:
This API will extract all the data contained in any ID you pass to it into a structured JSON response. This API uses Object Character Recognition to provide the response.
Just pass the URL of the document you want to analyze. Receive a JSON response with all the information contained in a structured way.
Get the image of the signature and the profile picture.
Get name, surname, address, date of birth, expiration date, issuing date, document number, sex and all other data that is contained in the ID.
Standardize your information: Receive standardized data to store it in your databases.
Data validation: Be able to extract relevant information about the ID. Be able to verify if the person is old enough, be able to verify if the name of the person matches the information you have stored, corroborate that the ID is not expired, and more.
This API is ideal to make security validations.
Besides API call limitations per month, there are no other limitations.
Extract structured text, portrait and signature from ID documents, such as driver’s licenses, passports, ID cards, permanent residence cards, etc. Multiple national ID documents are supported.
ID OCR - Endpoint Features
| Object | Description |
|---|---|
inputurl |
[Required] "inputurl" is the priority parameter,ensure images can be viewed properly.The speed of returning the result depends on the speed of the URL. |
{"code":"200","status":"SUCCESS","data":{"position":{"left":7,"bottom":6,"right":527,"top":333},"countryName":"United States","documentName":"Enhanced Driving License","errorCode":0,"nation":{"authority":"","givenNames":"SAMPLE, LICENSE","name":"DOCUMENT SAMPLE, LICENSE","nationality":"","placeOfBirth":"","sex":"F","surname":"DOCUMENT","surnameOfSpouse":""},"ocr":{"height":"?-0","dateOfExpiry":"2016-10-1","eyesColor":"BROWN","name":"DOCUMENT SAMPLE, LICENSE","addressState":"NEW YORK","issuingStateCode":"USA","dateOfBirth":"1985-6-9","dateOfIssue":"2008-9-30","sex":"F","dLClass":"D","dLRestrictionCode":"NONE","dLEndorsed":"NONE","surname":"DOCUMENT","addressPostalCode":"12345","addressJurisdictionCode":"NY","addressCity":"ANYTOWN","addressStreet":"2345 ANYPLACE AVE","address":"2345 ANYPLACE AVE^ANYTOWN NY 12345","givenNames":"SAMPLE, LICENSE","documentNumber":"012345678"},"portrait_rect":{"bottom":351,"left":21,"right":223,"top":104}},"_note":"Response truncated for documentation purposes"}
curl --location --request POST 'https://zylalabs.com/api/425/id+document+ocr+api/325/id+ocr?inputurl=https://static01.nyt.com/images/2008/09/16/nyregion/license533.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 commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
The API can recognize various types of ID documents, including passports, driver's licenses, national identification cards, and more.
The API utilizes Object Character Recognition (OCR) technology to extract data from ID documents. It analyzes the text and image elements to provide a structured JSON response.
Yes, the API supports multiple languages and can extract information from ID documents in different scripts, including non-Latin scripts like Cyrillic, Arabic, Chinese, etc.
The API provides a comprehensive JSON response that includes data fields such as name, surname, address, date of birth, expiration date, issuing date, document number, sex, signature image, profile picture, and more.
While the API focuses on data extraction, it can assist in security validations by providing relevant information from ID documents. However, it does not independently verify the authenticity of the documents.
Yes, by extracting the date of birth from the ID document, you can calculate the age of the individual and perform age verification checks as per your requirements.
The API returns structured data extracted from ID documents, including personal information such as name, surname, address, date of birth, expiration date, issuing date, document number, sex, and images of the signature and portrait.
The response data is organized in a structured JSON format, with key sections for personal details, OCR data, and image information. Each section contains relevant fields, making it easy to parse and utilize the extracted information.
Key fields in the response include "name," "surname," "address," "dateOfBirth," "documentNumber," "sex," and images for "portrait" and "signature." These fields provide comprehensive details about the ID holder.
The API provides information such as personal identification details (name, address, date of birth), document specifics (document type, issuing date, expiration date), and visual data (portrait and signature images) from various ID documents.
Users can customize their requests by specifying the URL of the ID document they wish to analyze. The API processes the document and returns a tailored JSON response based on the extracted data.
Typical use cases include identity verification, age validation, data standardization for databases, and security checks for compliance in various industries such as finance, travel, and law enforcement.
Data accuracy is maintained through advanced OCR technology that ensures precise extraction from ID documents. Regular updates and improvements to the OCR algorithms also enhance the reliability of the extracted data.
If the API returns partial or empty results, check the quality of the input document (e.g., image clarity, completeness). Ensure the document is supported and properly formatted. You may also retry with a different document if issues persist.
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:
1,812ms
Service Level:
100%
Response Time:
1,245ms
Service Level:
100%
Response Time:
482ms
Service Level:
100%
Response Time:
1,344ms
Service Level:
100%
Response Time:
1,429ms
Service Level:
100%
Response Time:
737ms
Service Level:
100%
Response Time:
1,586ms
Service Level:
100%
Response Time:
857ms
Service Level:
100%
Response Time:
1,076ms
Service Level:
100%
Response Time:
1,945ms
Service Level:
100%
Response Time:
291ms
Service Level:
100%
Response Time:
615ms
Service Level:
100%
Response Time:
569ms
Service Level:
100%
Response Time:
7,797ms
Service Level:
100%
Response Time:
103ms
Service Level:
100%
Response Time:
104ms
Service Level:
100%
Response Time:
121ms
Service Level:
100%
Response Time:
6,898ms
Service Level:
100%
Response Time:
2,570ms
Service Level:
100%
Response Time:
618ms