Criar novo dossiê

Cria um novo dossiê de consulta assíncrona sobre um CPF ou CNPJ.

O dossiê agregará os relatórios solicitados. Atualmente estão disponíveis os relatórios CAR (Cadastro Ambiental Rural) e INCRA (Sistema Nacional de Cadastro Rural).

Busca de Propriedades no CAR

Para o relatório CAR, você pode controlar onde buscar o CPF/CNPJ usando o parâmetro tipo_busca:

  • tipo_busca: 2 (padrão) - Busca apenas onde a pessoa é proprietária/titular
  • tipo_busca: 1 - Busca apenas onde a pessoa é cadastrante (quem registrou no CAR)
  • tipo_busca: 0 - Busca em ambos (proprietário OU cadastrante)

Recomendação: Use tipo_busca: 2 (padrão) para verificar propriedades de fato pertencentes à pessoa. O cadastrante pode ser um terceiro (despachante, contador, etc).

Webhook (RECOMENDADO)

Forneça webhook_url para receber notificação automática quando o dossiê estiver pronto. Isso elimina a necessidade de fazer polling (consultas repetidas) para verificar o status.

Quando o dossiê estiver completo, faremos um POST para o seu webhook_url com:

{
  "dossie_id": "uuid",
  "status": "COMPLETE",
  "cpf_cnpj": "12345678900",
  "car_count": 3
}

Vantagens do webhook:

  • Notificação instantânea quando pronto
  • Economia de requests (melhor para você e para nós)
  • Implementação mais simples (sem loops de polling)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 11 and 18

CPF (11 dígitos) ou CNPJ (14 dígitos) a consultar.

Pode ser enviado com ou sem formatação:

  • CPF: "12345678900" ou "123.456.789-00"
  • CNPJ: "12345678000190" ou "12.345.678/0001-90"
relatorios
array of strings
Defaults to car

Tipos de relatórios a gerar.

Relatórios disponíveis:

  • car: Cadastro Ambiental Rural (SICAR)
  • incra: Sistema Nacional de Cadastro Rural (INCRA/SNCR)

Você pode solicitar múltiplos relatórios em uma mesma consulta. Exemplo: ["car", "incra"]

Valor padrão: ["car"]

relatorios
integer
0 to 30
Defaults to 7

[Apenas para relatório CAR] Idade máxima aceitável dos dados demonstrativos do CAR, em dias.

Se os dados demonstrativos do CAR tiverem mais que max_age dias, o sistema agendará atualização automática através do spider.

Nota: Este parâmetro não afeta o relatório INCRA, que sempre retorna os dados mais recentes disponíveis no Elasticsearch.

  • Mínimo: 0 (sempre buscar atualização)
  • Máximo: 30 dias
  • Padrão: 7 dias
integer
enum
Defaults to 2

[Apenas para relatório CAR] Define onde buscar o CPF/CNPJ:

  • 0: Busca em ambos (proprietário OU cadastrante)
  • 1: Busca apenas onde é cadastrante (quem registrou no CAR)
  • 2: Busca apenas onde é proprietário/titular (PADRÃO RECOMENDADO)

Importante: O cadastrante pode ser um terceiro (despachante, contador). Para verificar propriedades de fato pertencentes à pessoa, use tipo_busca: 2.

Valor padrão: 2

Allowed:
uri

URL que receberá notificação POST quando a consulta estiver completa.

A URL deve:

  • Aceitar requisições POST
  • Retornar status 2xx para confirmar recebimento
  • Processar o payload JSON enviado
webhook_headers
object

Headers HTTP customizados para enviar na chamada do webhook.

Útil para autenticação ou tracking.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json