{"type":"cpf","value":"11144477735","valid":true,"formatted":"111.444.777-35","digits":"11144477735"}
curl --location --request GET 'https://zylalabs.com/api/13138/identity+document+validator+api/26652/validate+document?type=cpf&value=11144477735' --header 'Authorization: Bearer YOUR_API_KEY'
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 Identity Document Validator API simply include your bearer token in the Authorization header.
| 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.
(Save 2 months with annual billing 🎉)
Trusted by leading companies
Validate and format identity and business document numbers with correct check digit verification. Instantly confirm whether a given number is valid and receive it in a clean formatted form. The service can also generate valid sample numbers for software testing and quality assurance. Simple, fast and stateless.
The Validate Document endpoint returns data regarding the validity of an identity or business document number. It includes fields indicating the document type, the original number, its validity status, a formatted version, and the raw digits.
The key fields in the response data include "type" (document type), "value" (original number), "valid" (boolean indicating validity), "formatted" (cleanly formatted number), and "digits" (raw number without formatting).
The response data is organized in a JSON format, containing key-value pairs. Each response includes the document type, the original number, its validity status, a formatted version, and the unformatted digits, making it easy to parse and utilize.
The Validate Document endpoint provides information on the validity of various identity and business document numbers, including their formatted versions and whether they pass check digit verification.
The Validate Document endpoint accepts parameters such as "document type" (e.g., CPF, CNPJ) and "number" (the document number to validate). Users must specify these to receive accurate validation results.
Data accuracy is maintained through rigorous check digit verification processes and regular updates to the validation algorithms, ensuring that the API provides reliable and valid results for document numbers.
Typical use cases include validating user identity during onboarding processes, ensuring compliance in financial transactions, and generating valid sample numbers for software testing and quality assurance.
Users can utilize the returned data by checking the "valid" field to confirm document authenticity, using the "formatted" field for display purposes, and leveraging the "type" field to understand the document category for further processing.
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