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:

CampoTipoDescrição
idtextoIdentificador da consulta (req_ + 26 caracteres). Guarde: é o que o suporte e o histórico usam. Ordena por data.
produtotextoO produto consultado.
ambientelive | testAmbiente da chave usada.
pessoatextoO 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-**).
referenciatextoA sua referência, quando enviada.
codigotextoO desfecho, para máquina. Veja a tabela abaixo.
resultadotextoO desfecho em português, para mostrar a pessoas.
cobradabooleanoSe esta consulta entrou na cobrança.
custotextoValor cobrado, com ponto decimal ("0.60"). "0.00" quando não cobrada.
detalheobjetoO que a fonte devolveu. Veja abaixo.
emdata e horaQuando a consulta foi feita (RFC 3339, UTC).

Códigos de resultado

codigoQuandoCobra
nada_constaCertidão emitida sem registros (ou situação regular).Sim
constaCertidão emitida com registros, débitos ou pendências.Sim
emitidaCertidã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
dadosConsulta de dados com resultado.Sim
sem_registrosA consulta foi feita e a fonte não tem registros para o que foi pedido.Sim
encontradoProduto crm: inscrição encontrada.Sim
nao_encontradoProduto crm: o conselho não tem inscrição com esse CRM nessa UF.Sim
foto_reprovadaProduto 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_divergentesO órgão consultou e respondeu que os dados enviados não batem com o cadastro dele (RG, expedição, nascimento).Sim
em_processamentoO ó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_retornoO órgão não respondeu em nenhuma tentativa.Não
indisponivelO órgão avisou manutenção, ou a consulta está fora do ar na origem.Não
nao_emitidaRegra do órgão impede a certidão (menor de idade, PEP, CNPJ inativo). O motivo vem em detalhe.explicacao.Não
pedido_recusadoA origem recusou a chamada antes de consultar; repetir com os mesmos dados termina igual.Não
descontinuadaO órgão tirou esta consulta do ar.Não
documento_de_testeAmbiente 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

CampoAparece emDescrição
explicacaoTodosUma frase explicando o desfecho, pronta para mostrar.
linhaTodosLinha do tempo da consulta: lista de hora e oque.
certidaoCertidõesstatus (literal do órgão), numero, uf, emitidaEm, validaAte, texto e pdfBase64.
dadosConsultas de dados e alguns extras de certidãoObjeto com um campo por informação: nome fixo em camelCase e valor com tipo.
itensListas (processos, peças, sócios, inscrições, acordos…)Lista de registros, cada um com titulo e dados (um objeto, no mesmo formato).
medicoProduto crmDados da inscrição, sem veredito.
xmlsAPIs do eSocial, com incluirXml: trueXML 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:

TipoComo vemExemplo
Textotexto"tribunal": "TJSP"
Quantidade, medida e percentualnúmero"processos": 3
Valor em reaisnúmero, com ponto decimal"valorCausa": 4250.00
Sim ou nãotrue ou false"ajuizada": true
Datatexto AAAA-MM-DD"distribuicao": "2024-03-15"
Listalista de textos ou de objetos"andamentos": [{ "data": "2026-08-28", "texto": "Conclusos para decisão" }]
Totais por categoriaobjeto"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.

CampoO que fazExemplo
filtroDevolve só os itens que batem com todas as condições.{ "tribunal": "TJSP", "situacao": "ATIVA" }
ordenarOrdena pelo campo; - na frente inverte. Item sem o campo vai para o fim."-distribuicao"
limiteQuantos itens devolver, de 1 a 1000, depois do filtro e da ordem.10

Cada condição do filtro pode ser:

FormaBate quandoExemplo
Um valoro campo é igual (texto sem diferenciar maiúscula; em campo de lista, basta um item)"uf": "SP"
Lista de valoreso campo é um deles"tribunal": ["TJSP", "TRT2"]
de e atea data está no período (AAAA-MM-DD)"distribuicao": { "de": "2024-01-01", "ate": "2024-12-31" }
min e maxo número está na faixa"valorCausa": { "min": 1000 }
contemo 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
Simnada_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,34foto_reprovada, na validação de documento.
Nãoem_processamento, sem_retorno, indisponivel, nao_emitida, pedido_recusado, descontinuada e documento_de_teste.
NãoQualquer erro HTTP 4xx ou 503: a consulta não aconteceu.
NuncaChave 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 é 402 e 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.