API Reference

Criando um Novo Lote

1️⃣ Selecione a cesta

Escolha a cesta que será utilizada para realizar as consultas.

⚠️ Apenas as cestas habilitadas para Consulta em Lote serão exibidas para seleção.

Cestas que possuem fontes incompatíveis com a modalidade de lote não estarão disponíveis nessa opção.


2️⃣ Baixe o modelo de arquivo

Utilize o modelo disponibilizado pelo sistema para montar sua base de dados.

O template é fornecido no formato .CSV, garantindo que o arquivo esteja no padrão esperado para processamento.


3️⃣ Verifique os campos obrigatórios

Após selecionar a cesta, o sistema apresentará os campos obrigatórios necessários para realizar as consultas.

Preencha todos os campos obrigatórios conforme o modelo disponibilizado.

⚠️ O preenchimento incorreto ou incompleto dos campos poderá impedir o envio do lote.


4️⃣ Faça o upload do arquivo

Após preencher o arquivo, faça o upload na plataforma.

O arquivo deve atender aos seguintes requisitos:

📄 Formato: .CSV
📦 Tamanho máximo: 1 MB
🔢 Aproximadamente 25 mil consultas por lote

Após selecionar o arquivo, clique em Enviar lote.


5️⃣ Validação automática

Após o envio, o Data Engine realiza automaticamente a validação do arquivo.

Caso seja identificada alguma inconsistência, uma mensagem será apresentada informando o que precisa ser corrigido antes do processamento.

❌ Possíveis erros

O sistema poderá apresentar erros quando:

Um ou mais campos obrigatórios não estiverem preenchidos;
Houver informação inválida no campo CPF/CNPJ;
O arquivo possuir tamanho superior a 1 MB;
O arquivo não estiver no formato .CSV.


6️⃣ Confirme o envio

Após a validação do arquivo, confirme o envio da consulta.

O sistema iniciará automaticamente o processamento dos registros.