{
"document_type": "cpf",
"input_value": "11144477735",
"formatted_value": "111.444.777-35",
"is_valid": true
}
curl --location --request GET 'https://zylalabs.com/api/13818/brazilian+document+validator+api/31683/validate+cpf&cpf=Required' --header 'Authorization: Bearer YOUR_API_KEY'
{
"document_type": "cnpj",
"input_value": "11222333000181",
"formatted_value": "11.222.333/0001-81",
"is_valid": true
}
curl --location --request GET 'https://zylalabs.com/api/13818/brazilian+document+validator+api/31684/validate+cnpj&cnpj=Required' --header 'Authorization: Bearer YOUR_API_KEY'
{
"document_type": "cnh",
"input_value": "12345678900",
"formatted_value": null,
"is_valid": true
}
curl --location --request GET 'https://zylalabs.com/api/13818/brazilian+document+validator+api/31685/validate+cnh&cnh=Required' --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 Brazilian 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.
Validate Brazilian CPF, CNPJ and CNH documents with real check-digit calculation.
Each endpoint returns validation data for Brazilian documents: CPF, CNPJ, and CNH. The response includes the document type, input value, formatted value (if applicable), and a validity status indicating whether the document is valid.
The key fields in the response data are `document_type` (indicating the type of document), `input_value` (the original input), `formatted_value` (the formatted document number), and `is_valid` (a boolean indicating validity).
The response data is organized in a JSON format. Each response contains fields that provide information about the document type, the original input, its formatted version, and its validity status, making it easy to parse and utilize.
Each endpoint provides validation information for specific Brazilian documents: CPF (individual taxpayer ID), CNPJ (company taxpayer ID), and CNH (driver's license). This includes whether the document is valid and its formatted representation.
The endpoints accept document numbers as parameters, which can be provided with or without punctuation for CPF and CNPJ. For CNH, only an 11-digit number without punctuation is accepted.
Data accuracy is maintained through real check-digit calculations for CPF, CNPJ, and CNH. This ensures that the validation process adheres to the official algorithms used in Brazil for these documents.
Typical use cases include verifying the identity of individuals or companies, ensuring compliance with regulations, and preventing fraud in transactions that require valid Brazilian documents.
Users can utilize the returned data by checking the `is_valid` field to confirm document validity. The `formatted_value` can be used for display purposes, while the `input_value` can be stored for record-keeping or 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