{
"valid": true,
"type": "bank_slip",
"input_format": "digitable_line",
"barcode": "21299758700000020000001121100012100447561740",
"digitable_line": "21290001192110001210904475617405975870000002000",
"digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000",
"checks": {
"field_1_dv": true,
"field_2_dv": true,
"field_3_dv": true,
"barcode_dv": true
},
"errors": [],
"warnings": [],
"bank": {
"code": "212",
"name": "Banco Original"
},
"currency": "BRL",
"segment": null,
"amount_cents": 2000,
"amount": "20.00",
"due_date": "2018-07-16",
"due_date_status": "ok",
"overdue": true
}
curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32113/validate+a+boleto?code=21290.00119 21100.012109 04475.617405 9 75870000002000' --header 'Authorization: Bearer YOUR_API_KEY'
{
"converted": true,
"type": "bank_slip",
"barcode": "21299758700000020000001121100012100447561740",
"digitable_line": "21290001192110001210904475617405975870000002000",
"digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000"
}
curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32115/convert+between+digitable+line+and+barcode?code=21290.00119 21100.012109 04475.617405 9 75870000002000' --header 'Authorization: Bearer YOUR_API_KEY'
{
"code": "341",
"name": "Itaú Unibanco"
}
curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32117/look+up+a+bank+by+its+3-digit+compe+code&code=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 Boleto 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 🎉)
Validate Brazilian boletos (bank slips and utility/tax bills), verify check digits, extract bank, amount and due date, and convert between digitable line and barcode.
Each endpoint returns JSON data containing information about Brazilian boletos, including validation results, bank details, payment amounts, due dates, and conversion results between digitable lines and barcodes.
Key fields include "valid" (boolean), "bank" (object with "code" and "name"), "amount" (string), "due_date" (string), and "checks" (object detailing check digit validations). These fields provide essential information about the boleto's validity and details.
The returned data is structured in JSON format, with nested objects for complex data. For example, the "bank" field is an object containing "code" and "name," while "checks" provides validation results for each check digit.
Each endpoint provides information on boleto validation, including check digit verification, issuing bank details, payment amounts, due dates, and conversion between digitable lines and barcodes.
The GET and POST validation endpoints accept a boleto in either barcode or digitable line format. The conversion endpoints accept either format as input, ensuring the check digits are valid for successful conversion.
The response data is organized into key-value pairs, with primary validation results at the top level and detailed information (like bank details and checks) nested within specific objects, allowing for easy access to relevant data.
Typical use cases include validating the integrity of Brazilian boletos before processing payments, converting between formats for user convenience, and looking up bank information based on COMPE codes for financial applications.
Data accuracy is maintained through the use of official FEBRABAN check-digit algorithms for validation. The API performs mathematical checks without relying on external data sources, ensuring consistent and reliable results.
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