Ler a resposta
O envelope que toda consulta devolve, os códigos de resultado, o objeto detalhe e quando há cobrança.
A resposta
Toda consulta responde o mesmo envelope, em qualquer produto:
| Campo | Tipo | Descrição |
|---|---|---|
id | texto | Identificador da consulta (req_ + 26 caracteres). Guarde: é o que o suporte e o histórico usam. Ordena por data. |
produto | texto | O produto consultado. |
ambiente | live | test | Ambiente da chave usada. |
pessoa | texto | O que foi consultado: o CPF inteiro e formatado (000.000.001-91), CNPJ formatado, ou a chave consultada (Placa ABC1D23, 1234567/SP no produto crm). Na consulta antiga, de antes do CPF inteiro ser guardado, o CPF sai só com o miolo (***.000.001-**). |
referencia | texto | A sua referência, quando enviada. |
codigo | texto | O desfecho, para máquina. Veja a tabela abaixo. |
resultado | texto | O desfecho em português, para mostrar a pessoas. |
cobrada | booleano | Se esta consulta entrou na cobrança. |
custo | texto | Valor cobrado, com ponto decimal ("0.60"). "0.00" quando não cobrada. |
detalhe | objeto | O que a fonte devolveu. Veja abaixo. |
em | data e hora | Quando a consulta foi feita (RFC 3339, UTC). |
Códigos de resultado
codigo | Quando | Cobra |
|---|---|---|
nada_consta | Certidão emitida sem registros (ou situação regular). | Sim |
consta | Certidão emitida com registros, débitos ou pendências. | Sim |
emitida | Certidão emitida com uma situação que não é "nada consta" nem "consta" (ex.: positiva com efeitos de negativa). O status literal vem em detalhe.certidao.status. | Sim |
dados | Consulta de dados com resultado. | Sim |
sem_registros | A consulta foi feita e a fonte não tem registros para o que foi pedido. | Sim |
encontrado | Produto crm: inscrição encontrada. | Sim |
nao_encontrado | Produto crm: o conselho não tem inscrição com esse CRM nessa UF. | Sim |
foto_reprovada | Produto documento-validacao: foto fora do padrão (escura, borrada, longe, resolução baixa), sem documento legível ou com documento fechado. Os motivos vêm em detalhe.dados. | Sim, a R$ 0,34 |
dados_divergentes | O órgão consultou e respondeu que os dados enviados não batem com o cadastro dele (RG, expedição, nascimento). | Sim |
em_processamento | O órgão não respondeu ainda. A consulta está na fila e é refeita sozinha em 1, 5, 10, 15, 20, 30 e 60 minutos; o desfecho chega pelo webhook. Vem com HTTP 200. | Não |
sem_retorno | O órgão não respondeu em nenhuma tentativa. | Não |
indisponivel | O órgão avisou manutenção, ou a consulta está fora do ar na origem. | Não |
nao_emitida | Regra do órgão impede a certidão (menor de idade, PEP, CNPJ inativo). O motivo vem em detalhe.explicacao. | Não |
pedido_recusado | A origem recusou a chamada antes de consultar; repetir com os mesmos dados termina igual. | Não |
descontinuada | O órgão tirou esta consulta do ar. | Não |
documento_de_teste | Ambiente de testes: documento que não é de teste. Nada foi consultado. | Não |
sem_registros, nao_encontrado e dados_divergentes são cobrados: a consulta foi feita e a resposta é informação — "não há registros" é o resultado. foto_reprovada é cobrada a R$ 0,34: a foto foi conferida, mas não lida. Foto claramente ruim é recusada antes, com 422, sem cobrança.
O objeto detalhe
| Campo | Aparece em | Descrição |
|---|---|---|
explicacao | Todos | Uma frase explicando o desfecho, pronta para mostrar. |
linha | Todos | Linha do tempo da consulta: lista de hora e oque. |
certidao | Certidões | status (literal do órgão), numero, uf, emitidaEm, validaAte, texto e pdfBase64. |
dados | Consultas de dados e alguns extras de certidão | Objeto com um campo por informação: nome fixo em camelCase e valor com tipo. |
itens | Listas (processos, peças, sócios, inscrições, acordos…) | Lista de registros, cada um com titulo e dados (um objeto, no mesmo formato). |
medico | Produto crm | Dados da inscrição, sem veredito. |
xmls | APIs do eSocial, com incluirXml: true | XML oficial de cada evento: evento (ex.: S-5013), id, recibo e xmlBase64. |
Em dados, cada informação tem nome fixo (comoReu, valorCausa, distribuicao) e valor com tipo:
| Tipo | Como vem | Exemplo |
|---|---|---|
| Texto | texto | "tribunal": "TJSP" |
| Quantidade, medida e percentual | número | "processos": 3 |
| Valor em reais | número, com ponto decimal | "valorCausa": 4250.00 |
| Sim ou não | true ou false | "ajuizada": true |
| Data | texto AAAA-MM-DD | "distribuicao": "2024-03-15" |
| Lista | lista de textos ou de objetos | "andamentos": [{ "data": "2026-08-28", "texto": "Conclusos para decisão" }] |
| Totais por categoria | objeto | "porTribunal": { "TJSP": 2, "TRT2": 1 } |
Código que parece número continua texto, para não perder zero à esquerda: CEP, matrícula, inscrição, número de documento. Campo sem valor na fonte não é enviado: trate todo campo de dados como opcional. Os campos de cada produto estão listados na página do produto, e o exemplo de resposta ao lado mostra o formato exato.
Filtro, ordem e limite
Nos produtos que devolvem detalhe.itens (processos, inscrições, sócios, acordos…), o corpo aceita três campos complementares que agem sobre essa lista. Eles usam os mesmos nomes de campo que vêm dentro de dados de cada item.
| Campo | O que faz | Exemplo |
|---|---|---|
filtro | Devolve só os itens que batem com todas as condições. | { "tribunal": "TJSP", "situacao": "ATIVA" } |
ordenar | Ordena pelo campo; - na frente inverte. Item sem o campo vai para o fim. | "-distribuicao" |
limite | Quantos itens devolver, de 1 a 1000, depois do filtro e da ordem. | 10 |
Cada condição do filtro pode ser:
| Forma | Bate quando | Exemplo |
|---|---|---|
| Um valor | o campo é igual (texto sem diferenciar maiúscula; em campo de lista, basta um item) | "uf": "SP" |
| Lista de valores | o campo é um deles | "tribunal": ["TJSP", "TRT2"] |
de e ate | a data está no período (AAAA-MM-DD) | "distribuicao": { "de": "2024-01-01", "ate": "2024-12-31" } |
min e max | o número está na faixa | "valorCausa": { "min": 1000 } |
contem | o texto tem o trecho; em lista, procura dentro de cada item | "quemParticipa": { "contem": "silva" } |
{
"cpf": "000.000.001-91",
"filtro": { "tribunal": "TJSP", "valorCausa": { "min": 1000 } },
"ordenar": "-distribuicao",
"limite": 10
}Quando algum dos três é enviado, detalhe.totalItens diz quantos itens a consulta trouxe antes do recorte. O resumo em detalhe.dados continua sendo o da consulta inteira. A consulta e a cobrança são as mesmas: o recorte só escolhe o que volta na resposta. Campo que o item não tem não bate em filtro nenhum; valor fora do formato é recusado com 422.
Cobrança
| Cobra? | Quando |
|---|---|
| Sim | nada_consta, consta, emitida, dados, sem_registros, encontrado, nao_encontrado e dados_divergentes, pelo preço do produto para a sua conta. |
| Sim, a R$ 0,34 | foto_reprovada, na validação de documento. |
| Não | em_processamento, sem_retorno, indisponivel, nao_emitida, pedido_recusado, descontinuada e documento_de_teste. |
| Não | Qualquer erro HTTP 4xx ou 503: a consulta não aconteceu. |
| Nunca | Chave de teste. |
O preço de cada produto para a sua conta está no portal, em Produtos — pode ter faixa por volume ou preço especial. O campo custo mostra o valor cobrado em cada consulta.
- Pré-pago: cada consulta desconta do saldo. Sem saldo para o preço da consulta, a resposta é
402e nada é consultado. - Mensal: as consultas somam na fatura do mês, que fecha no último dia e vence no dia 10. A fatura vai por e-mail em PDF, com o QR code do PIX. Depois do vencimento há multa de 2% e juros de 1% ao mês, proporcionais aos dias de atraso, e as consultas são bloqueadas no dia seguinte até o pagamento ser confirmado.