Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.judit.io/llms.txt

Use this file to discover all available pages before exploring further.

Novo CNPJ (IN 2229/24)A Judit já aceita o novo formato de CNPJ alfanumérico em conformidade com a Instrução Normativa RFB nº 2229/2024.
  • Zero esforço: nenhuma alteração é necessária na sua integração.
  • Ambiente de teste: utilize o documento A1B2C3D4/E5F6-68 para validar o fluxo e receber um processo fictício de resposta.
A Consulta por Dados Cadastrais retorna informações de identificação de uma Pessoa Física ou Jurídica: nome/razão social, situação cadastral, endereços, contatos, sócios e relacionamentos. Toda a chamada é síncrona e pode ler do datalake da Judit (rápido e barato) ou direto da Receita Federal em tempo real (on_demand: true).
🤖 Endpoint: POST https://lawsuits.production.judit.io/entities. search_type aceita cpf, cnpj ou name. response_type é sempre entity. Para resposta em tempo real (Receita), envie on_demand: true no payload.

Quando usar

Onboarding e KYC

Valide nome, situação cadastral e endereço durante o cadastro do cliente sem fricção adicional.

Enriquecimento de base

Atualize seu CRM/ERP com dados consolidados por CPF/CNPJ.

Anti-fraude

Confronte dados informados pelo usuário com a versão oficial em segundos.

Mapeamento de grupo econômico

Use a resposta para descobrir filiais e relacionamentos societários ligados a um CNPJ.

Datalake vs. On-Demand (Receita Federal)

CaracterísticaDatalake (padrão)On-Demand (on_demand: true)
Latênciamssegundos
FonteCache JUDITReceita Federal em tempo real
AtualidadeÚltima coleta JUDITEstado atual da Receita
CustoMais baratoMais caro
Caso idealOnboarding rápido, enriquecimento em massaCompliance crítico, decisões de alto risco

Passo 1: Criar a Consulta (POST)

POST https://lawsuits.production.judit.io/entities

Exemplos por tipo de documento

{
    "search": {
        "search_type": "cpf",
        "search_key": "999.999.999-99"
    }
}
Ao realizar consultas por nome, é possível que existam homônimos (pessoas ou empresas com o mesmo nome). Sempre que possível, prefira CPF ou CNPJ para garantir maior precisão.

Parâmetros do Payload

ParâmetroTipoObrigatórioDescrição
search.search_typestringSim"cpf", "cnpj" ou "name".
search.search_keystringSimDocumento ou nome a buscar.
search.response_typestringSimSempre "entity".
search.on_demandbooleanNãoSe true, força leitura em tempo real na Receita Federal.
search.reveal_partners_documentsbooleanNão(CNPJ) Retorna documentos não mascarados dos sócios.

Exemplo de Requisição (POST)

curl --location 'https://lawsuits.production.judit.io/entities' \
  --header 'api-key: '"$JUDIT_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
    "search": {
      "search_type": "cpf",
      "search_key": "999.999.999-99"
    }
  }'

Passo 2: Ler a Resposta

A resposta vem no corpo do mesmo POST. Os campos principais:
CampoTipoDescrição
request_idstringIdentificador único da consulta.
response_dataarrayLista de entidades encontradas (segue o Schema Entity).
response_data[].entity_typestring"person" (PF) ou "company" (PJ).
response_data[].main_documentstringCPF ou CNPJ.
response_data[].addressesarrayEndereços associados.
response_data[].contactsarrayTelefones e e-mails.
response_data[].partnersarray(PJ) Sócios e administradores.

Exemplos de Resposta

{
    "has_lawsuits": false,
    "request_id": "5c618521-2ecc-4176-a573-431d2e0edeb2",
    "response_data": [
        {
            "entity_id": "",
            "entity_type": "person",
            "main_document": "999.999.999-99",
            "name": "JOÃO TESTE",
            "addresses": [
                {
                    "street": "RUA RAMOS DE CARVALHO",
                    "number": "999",
                    "neighborhood": "CENTRO",
                    "city": "RIO DE JANEIRO",
                    "state": "RJ",
                    "country": "Brasil",
                    "zip_code": "99999999"
                }
            ],
            "contacts": [
                { "description": "21999999999", "contact_type": "phone" }
            ],
            "parents": [
                { "name": "JANAINA DA SILVA", "kinship": "mother" }
            ],
            "tags": { "revenue_update_date": "2022-05-30T00:00:00.000Z" },
            "nationality": "BRASILEIRA",
            "birth_date": "1981-08-07T00:00:00.000Z",
            "gender": "male",
            "revenue_service_active": true,
            "created_at": "2024-10-12T13:28:59.051Z",
            "updated_at": "2024-10-12T13:28:59.051Z"
        }
    ]
}
Estrutura completa de cada item: veja Schema Entity. Glossário de campos: Glossário.
Ao consultar por CNPJ com reveal_partners_documents: true, retornamos os CPFs/CNPJs dos sócios sem mascaramento. Use somente quando há base legal/contratual (LGPD).

Erros comuns

HTTPQuando aconteceComo tratar
400Documento em formato inválido / response_type ausente.V