Consulta em lote - 🧪 Beta#

A consulta em lote permite o envio de arquivos CSV contendo até 3.000 registros para processamento assíncrono. Após o término do processamento, o resultado será enviado por e-mail ao endereço especificado.

Envio da solicitação#

Exemplo de chamada

cURL:

curl --request POST \
  --url https://api.jusbrasil.com.br/background-check/consulta-em-lote \
  --header 'Content-Type: multipart/form-data' \
  --header 'apikey: <sua_api_key>' \
  --form 'request={
    "sources": ["CRIMINAL", "CIVIL", "TRABALHISTA"],
    "return_type": "EMAIL",
    "return_address": "seu.email@dominio.com",
    "has_header": true
  }' \
  --form file=@/caminho/do/arquivo.csv

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 11,
    "mensagem": "A requisição de Consulta em Lote ID 11 foi solicitada com sucesso.",
    "arquivo": "arquivo.csv"
}

Exemplo de CSV a ser enviado#

arquivo.csv:

cpf_cnpj
11111111111
00000000000
43902940000
...

Nota

Será enviado um e-mail com a notificação do fim do processamento
Por enquanto, o número máximo de CPFs/CNPJs por arquivo CSV está limitado a 3.000 registros.
O arquivo deve ser enviado no formato CSV
O arquivo deve conter uma lista de CPFs/CNPJs separados por linha, seguindo o exemplo acima
A requisição deve ser enviada no formato multipart/form-data
Todos os CPFs/CNPJs devem ser válidos e devem estar no formato numérico (sem caracteres como ponto ou hífen) com tamanho de 11 para CPF ou 14 dígitos para CNPJ
O usuário deve solicitar os sources conforme tenha a permissão de acesso

Aviso

Sempre aguarde o término da consulta anterior para enviar a próxima.
A consulta em lote pode levar aproximadamente 30 minutos para ser processada

**Parâmetros de envio do campo request**#
Parâmetro	Tipo	Descrição
sources	List - String	Lista com as fontes a serem consultadas. Possíveis valores: `CRIMINAL` `CIVIL` `TRABALHISTA`
return_type	String	Forma de retorno. Atualmente, aceita apenas `"EMAIL"`.
return_address	String	Endereço de e-mail que receberá notificação sobre o fim do processamento.
has_header	Boolean	Define se o CSV possui linha de cabeçalho. Valor booleano

Consulta de processamentos#

Permite consultar os últimos 10 processamentos enviados.

cURL:

curl --request GET \
  --url https://api.jusbrasil.com.br/background-check/consulta-em-lote/ \
  --header 'apikey: <sua_api_key>'

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "id": 94,
        "fontes": "CRIMINAL,CIVIL,TRABALHISTA",
        "endereco_retorno": "seu.email@dominio.com",
        "data_criacao": "2025-04-10 23:29:26",
        "data_atualizacao": "2025-04-10 23:29:29",
        "status": "EM PROCESSAMENTO"
    },
    {
        "id": 93,
        "fontes": "CRIMINAL,CIVIL",
        "endereco_retorno": "seu.email@dominio.com",
        "data_criacao": "2025-02-06 10:29:26",
        "data_atualizacao": "2025-02-06 10:29:29",
        "status": "CONCLUÍDO"
    },
    {
        "id": 88,
        "fontes": "CRIMINAL,CIVIL",
        "endereco_retorno": "seu.email@dominio.com",
        "data_criacao": "2025-01-01 10:29:26",
        "data_atualizacao": "2025-01-01 10:29:29",
        "status": "FALHA"
    }
]

**Parâmetros de consulta de processamentos**#
Parâmetro	Tipo	Descrição
id	String	ID do processamento a ser consultado
fontes	String	Fontes consultadas
endereco_retorno	String	Endereço de e-mail que receberá notificação sobre o fim do processamento
data_criacao	String	Data de criação do processamento
data_atualizacao	String	Data de atualização do processamento
status	String	Status do processamento. Possíveis valores: `PENDENTE` `EM PROCESSAMENTO` `CONCLUÍDO` `FALHA`

Download dos resultados#

Permite o download dos resultados em formato ZIP, que contem o arquivo CSV com os resultados da consulta.

cURL:

curl --request GET \
  --url https://api.jusbrasil.com.br/background-check/consulta-em-lote/download/<id_consulta> \
  --header 'apikey: <sua_api_key>' \
  --output /nome_do_arquivo_de_saida.zip

**Parâmetros de download**#
Parâmetro	Tipo	Descrição
id_consulta	String	ID da consulta a ser baixada
output	String	Nome e caminho do arquivo de saída