# Cnab Online API

> Cnab Online API on Apizie: 4 endpoints (Faz o upload de um arquivo, Retorna as informações básicas de um arquivo previamente processado, Retorna todas as linhas e seus respectivos campos (de forma não processada, apenas indicando os campos…, Retorna as informações de baixa de boletos e outros tipos de ocorrências) returned as clean JSON through one API key. 4 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:cnab-online-herokuapp`
- Category: Finance
- Status: live
- Source: https://cnab-online.herokuapp.com
- Page: https://zieapi.vercel.app/api/finance/cnab-online-herokuapp
- OpenAPI: https://zieapi.vercel.app/api/finance/cnab-online-herokuapp/openapi.json

Processe arquivos de retorno CNAB

## Endpoints

### Faz o upload de um arquivo
`POST https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/post-file`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Retorna as informações básicas de um arquivo previamente processado
`GET https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/get-file-file-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| fileId | string | yes | ID Temporário gerado no endpoint file |

### Retorna todas as linhas e seus respectivos campos (de forma não processada, apenas indicando os campos…
`GET https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/get-file-file-id-lines`

| Parameter | Type | Required | Description |
|---|---|---|---|
| fileId | string | yes | ID Temporário gerado no endpoint file |

### Retorna as informações de baixa de boletos e outros tipos de ocorrências
`GET https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/get-file-file-id-occurrences`

| Parameter | Type | Required | Description |
|---|---|---|---|
| fileId | string | yes | ID Temporário gerado no endpoint file |

## Example
```
curl "https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/post-file" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Cnab Online API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/finance:cnab-online-herokuapp/post-file with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Cnab Online API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Cnab Online API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:cnab-online-herokuapp.

### What is the status of the Cnab Online API?
Live: works with just an Apizie key