Each endpoint returns detailed identity information extracted from Machine Readable Zones (MRZ) of documents. This includes document type, issuer country, personal details (name, birth date, gender), and validation results indicating the accuracy of the data.

Key fields in the response include `isValid`, `mrzType`, `documentType`, `documentNumber`, `issuerCountry`, `firstName`, `surname`, `birthDate`, `expiryDate`, and `validation` details, which provide insights into the validity of the document.

The endpoints provide information on document types (passports, ID cards), personal identification details (name, birth date), and validation results (checksum and format checks) for various documents, including Polish IDs and passports.

The response data is structured in JSON format, with each document's details encapsulated in an object. For multiple documents, an array of objects is returned, allowing easy access to individual document validations and extracted data.

The data is sourced from standardized Machine Readable Zones (MRZ) as defined by ICAO standards. This ensures high accuracy and compliance with international document verification protocols.

Typical use cases include identity verification for travel, onboarding processes in financial services, and compliance checks in various sectors where document authenticity is critical.

Users can customize requests by providing either raw MRZ text or an array of MRZ lines. This flexibility allows for different input formats based on user needs, enhancing the API's usability.

If the API returns partial or empty results, users should check the `isValid` field for validation status. The `errorMessage` in the validation object can provide insights into specific issues, guiding users on necessary corrections.

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key 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.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

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. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

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.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund