Cnab Online

Name: Cnab Online API
Brand: Cnab Online
Availability: InStock

✓ Official Vendor SpecFinanceBankingnone4 EndpointsREST

For Agents

Parse Brazilian CNAB return files into structured JSON to read boleto write-offs and bank occurrences from a single file upload.

Install Jentic One Beta

Connect the Cnab Online to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cnab Online, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Cnab Online API.

Upload a CNAB return file via POST /file and receive a parse identifier

Retrieve basic metadata for an uploaded file via GET /file/{fileId}

List every recognised line and its parsed fields with GET /file/{fileId}/lines

GET STARTED

Start building with Cnab Online API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Cnab Online API for, with concrete tasks.

★ Boleto Reconciliation

Reconcile paid boletos against open invoices by uploading the daily CNAB return file from the bank and reading the parsed occurrences. POST /file accepts the raw CNAB file, then GET /file/{fileId}/occurrences returns the structured payment events so accounts receivable can mark invoices as paid. Replacing an in-house CNAB parser with this flow saves the multi-week effort of supporting bank-specific layouts.

Upload a CNAB 240 return file via POST /file, then call GET /file/{fileId}/occurrences and return all paid boletos.

Bank File Auditing

Audit incoming CNAB return files line by line to verify that the bank applied the expected events to each transaction. GET /file/{fileId}/lines returns every recognised line with its parsed fields, so a controller can compare totals and flag mismatches before posting to the ledger. Useful when integrating a new bank or when a layout version change introduces unexpected occurrences.

Call GET /file/{fileId}/lines for a previously uploaded CNAB file and return the count of lines per recognised record type.

Multi-Bank Boleto Aggregation

Accept CNAB return files from several Brazilian banks (Itaú, Bradesco, Santander, Caixa, Banco do Brasil) into one workflow. The API recognises common CNAB 240 and 400 layouts so a treasury system can normalise occurrences without maintaining a parser per bank. GET /file/{fileId} confirms that the upload was processed before downstream queries are issued.

Upload a CNAB return file from Banco do Brasil, then call GET /file/{fileId} and confirm processing succeeded before parsing occurrences.

AI Agent Boleto Workflow via Jentic

An AI agent in a finance ops workflow uses Jentic to upload a CNAB return file and pull occurrences without integrating directly with the Heroku-hosted parser. Because the API is unauthenticated, the agent can chain POST /file and GET /file/{fileId}/occurrences in a single workflow while Jentic handles retries and error handling.

Use Jentic to search for 'parse CNAB return file', upload the file via POST /file, then return occurrences from GET /file/{fileId}/occurrences.

Key Endpoints

4 endpoints — cnab online parses brazilian cnab return files (arquivos de retorno) so finance teams and integrators can read boleto payment confirmations, write-offs, and other bank occurrences without writing a custom parser.

METHOD

PATH

DESCRIPTION

POST

/file

Upload a CNAB return file for parsing

GET

/file/{fileId}

Retrieve metadata for a parsed file

GET

/file/{fileId}/lines

List all recognised lines and their parsed fields

GET

/file/{fileId}/occurrences

Retrieve structured boleto and bank occurrences

POST

/file

Upload a CNAB return file for parsing

GET

/file/{fileId}

Retrieve metadata for a parsed file

GET

/file/{fileId}/lines

List all recognised lines and their parsed fields

GET

/file/{fileId}/occurrences

Retrieve structured boleto and bank occurrences

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

No credentials are required for the Cnab Online API. Jentic still proxies the call, applies retry policy, and tracks request metrics so the agent gets observability without any vault entry to manage.

Intent-based discovery

Agents search by intent (e.g. 'parse CNAB return file') and Jentic returns the upload and read operations with their input schemas, so the agent can construct a multi-step parse-and-read flow without reading Portuguese-language documentation.

Time to first call

Direct integration: a couple of hours to wire up multipart upload and the read endpoints. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using Cnab Online API through Jentic.

What authentication does the Cnab Online API use?

The OpenAPI spec declares no security schemes — the API is open and accepts file uploads without an API key. Through Jentic the call is still proxied for observability and retry handling, so an agent does not need to manage any credentials.

Can I parse both CNAB 240 and CNAB 400 files with this API?

Yes. POST /file accepts CNAB return files and the parser recognises both CNAB 240 and CNAB 400 layouts used by major Brazilian banks. The recognised fields are available via GET /file/{fileId}/lines after upload.

What are the rate limits for the Cnab Online API?

The OpenAPI spec does not declare numeric rate limits. The service runs on a single Heroku dyno, so high-volume callers should serialise uploads and avoid concurrent calls to /file from the same IP to prevent timeouts.

How do I retrieve boleto write-offs from a CNAB file through Jentic?

Search Jentic for 'parse CNAB return file', upload the file with POST /file to get a fileId, then call GET /file/{fileId}/occurrences to receive structured write-offs and other occurrences. Install the SDK with pip install jentic and call it via the async client.

Does this API generate boletos or transmit instructions to banks?

No. The API only parses CNAB return files. Generation of boletos (CNAB remessa) and transmission to banks must be handled by a separate service. Use this API when you already have a return file from the bank and need to extract structured data.

Is the API suitable for production reconciliation workloads?

It works well for prototypes and low-to-mid volume reconciliation. For high-throughput or strict SLA workloads consider hosting your own parser, since this service runs on a Heroku free-tier-style dyno and provides no published uptime guarantee.