Exportar erros em CSV

Baixa um relatório CSV com os erros de validação de todos os itens inválidos do lote.

GEThttps://external-api.arbitralis.com.br/api/external/v1/notifications/batches/{batchId}/errors.csv

AutenticaçãoX-API-KEYSíncrono — a resposta já traz o resultado

Devolve um arquivo CSV com todos os itens inválidos do lote e a razão de cada rejeição. É a forma mais direta de revisar problemas em massa: uma requisição traz o relatório inteiro, sem paginação.

A resposta é o arquivo em si (download), não um JSON.

Parâmetros de rota

batchIduuidobrigatório

Identificador do lote.

Colunas do relatório

Coluna	Conteúdo
`linha`	Número da linha no arquivo original
`nome`	Nome informado
`documento`	CPF ou CNPJ informado
`email`	E-mail informado
`telefone`	Telefone informado
`erros`	Motivos da rejeição

Headers da resposta

Header	Valor
`Content-Type`	`text/csv; charset=utf-8`
`Content-Disposition`	`attachment; filename="errors_<batchId>.csv"`

Fluxo de correção

Baixe o relatório de erros.
Corrija os registros na origem (sua base ou a planilha).
Reenvie apenas os corrigidos, com o mesmo batchCode — eles são agregados ao mesmo lote (ver Idempotência).
Confirme o envio.

O arquivo contém dados pessoais

O relatório traz nome, documento, e-mail e telefone dos destinatários. Trate-o como dado pessoal sob a LGPD: não versione em repositório, não envie por canal aberto e apague depois da correção.

Lote sem erros

Quando não há itens inválidos, o arquivo vem apenas com a linha de cabeçalho.

Erros

Código	Causa
`401`	API key ausente, inválida ou inativa
`404`	Lote não encontrado neste workspace
`429`	Limite de requisições excedido

Requisição

curl -X GET "https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/errors.csv" \
  -H "X-API-KEY: arb_live_SUA_CHAVE" \
  -o erros-lote.csv

import { writeFile } from 'node:fs/promises';

const batchId = '1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d';

const response = await fetch(
  `https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/${batchId}/errors.csv`,
  { headers: { 'X-API-KEY': 'arb_live_SUA_CHAVE' } }
);

await writeFile(`erros-${batchId}.csv`, Buffer.from(await response.arrayBuffer()));

import requests

batch_id = "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

response = requests.get(
    f"https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/{batch_id}/errors.csv",
    headers={"X-API-KEY": "arb_live_SUA_CHAVE"},
)

with open(f"erros-{batch_id}.csv", "wb") as arquivo:
    arquivo.write(response.content)

Resposta

linha;nome;documento;email;telefone;erros
14;João Pereira;98765432100;;+5521988888888;CPF/CNPJ inválido
27;Ana Lima;11122233344;ana.lima@;+5531977777777;E-mail inválido
41;Carlos Dias;55566677788;[email protected];;Telefone obrigatório para o método selecionado