Emitir diligência
Cria uma diligência para emissão de certidões e/ou Análise DiHub
Regras
- Os créditos são debitados na criação. A emissão das certidões é assíncrona: acompanhe com
GET /diligences/{id}/status. - Máximo de 2 comarcas por requisição.
- Pegue os valores de
stateedistrictemGET /diligences/districts. - As certidões emitidas em cada UF estão em Certidões e emissores.
documentaceita CPF ou CNPJ, com ou sem pontuação. O CNPJ pode ser alfanumérico; os dígitos verificadores do CNPJ são validados.- Para CPF, a Análise DiHub só é feita se o titular tiver 18 anos ou mais.
- Cobrança por cenário: Consumo de créditos.
Cenários
Certidões
Certidões
{
"document": "12345678901",
"documentIdentity": "MG12345678",
"districts": [
{ "state": "MG", "district": "BELO_HORIZONTE" },
{ "state": "SP", "district": "SAO_PAULO" }
]
}
districtsé obrigatório, com 1 ou 2 comarcas.documentIdentity(RG) é opcional e só vale para CPF.
Certidões + Análise DiHub
Certidões + Análise DiHub
{
"document": "12345678901",
"districts": [
{ "state": "MG", "district": "BELO_HORIZONTE" }
],
"creditAnalysis": true
}
- Titular menor de 18 anos: as certidões são emitidas, a análise não é feita e não é cobrada.
Só Análise DiHub
Só Análise DiHub
{
"document": "12345678901",
"creditAnalysisOnly": true
}
- Dispensa
districts. - Titular precisa ter 18 anos ou mais.
- Custa 1 crédito.
Erros
Todos os erros abaixo acontecem antes do débito: nenhum crédito é consumido.400 - Corpo inválido
400 - Corpo inválido
message traz o primeiro problema encontrado e data traz a lista completa, com path indicando o campo. Exemplos: O documento deve ter 11 ou 14 caracteres (CPF ou CNPJ), CNPJ inválido: dígito verificador não confere, Máximo de 2 distritos, Distritos são obrigatórios quando não é apenas Análise DiHub.400 - Comarca inválida
400 - Comarca inválida
Invalid district <COMARCA> in state <UF>: a comarca não existe na UF informada. Use os valores de GET /diligences/districts.400 - Créditos insuficientes
400 - Créditos insuficientes
Not enough credits. data traz requiredCredits e totalCreditsAmount. Solicite créditos no painel financeiro.400 - Titular menor de idade
400 - Titular menor de idade
Análise não realizada: usuário menor de idade. Só ocorre com creditAnalysisOnly: true.404 - Documento não encontrado
404 - Documento não encontrado
Subject Document Not Found: o CPF ou CNPJ não foi encontrado nas bases cadastrais. Confira o documento.422 - CPF sem data de nascimento
422 - CPF sem data de nascimento
Data de nascimento não disponível para o CPF informado.Authorizations
Token de API gerado no dashboard, enviado no header X-Api-Token.
Body
CPF (11 dígitos) ou CNPJ (14 caracteres). Pontuação é ignorada. O CNPJ pode ser alfanumérico: 12 caracteres A-Z/0-9 + 2 dígitos verificadores numéricos, que são validados.
"12345678901"
RG do titular, de 6 a 15 caracteres. Opcional; usado só para CPF.
6 - 15"MG12345678"
Comarcas onde as certidões serão emitidas (máximo 2). Obrigatório, exceto com creditAnalysisOnly: true. Valores válidos em GET /diligences/districts.
2Show child attributes
Show child attributes
[ { "state": "MG", "district": "BELO_HORIZONTE" } ]
Inclui a Análise DiHub junto com as certidões (+0,5 crédito). Só é feita se o titular tiver 18 anos ou mais; caso contrário, não é cobrada.
Faz só a Análise DiHub, sem certidões (1 crédito). Dispensa districts. Titular precisa ter 18 anos ou mais.
true usa o modelo anterior do relatório da Análise DiHub; false usa o modelo atual. Só tem efeito com Análise DiHub.