Skip to main content
POST

​
Regras importantes

  • Consulte GET /credits/balance antes de iniciar fluxos em lote.
  • Use no máximo 2 comarcas por requisição.
  • A Análise DiHub só é executada para titulares com 18 anos ou mais.
  • Para detalhes de cobrança, veja Consumo de créditos.

​
Cenários suportados

O endpoint suporta três cenários principais:
  • documentIdentity é opcional e usado apenas para CPF quando a certidão exigir.
  • districts é obrigatório e deve conter pelo menos uma comarca.
  • districts pode conter até 2 comarcas.
  • documentIdentity é opcional e usado apenas para CPF quando a certidão exigir.
  • Não é necessário informar districts.
  • O titular deve ter ser maior de 18 anos.
  • Quando sozinha, a Análise DiHub consome 1 crédito.

​
Erros comuns e como tratar

O details traz path e message indicando o campo incorreto. Verifique o formato do CPF (11 dígitos) ou CNPJ (14 caracteres — pode ser alfanumérico a partir de jul/2026) e se districts está preenchido quando necessário.
Enviado quando creditAnalysisOnly é false e districts está ausente ou vazio. Informe pelo menos uma comarca.
O details inclui requiredCredits e totalCreditsAmount. Consulte GET /credits/balance e solicite créditos no painel financeiro.
A comarca informada não existe para o estado. Verifique a lista em Todas as certidões.
O titular tem menos de 18 anos. A Análise DiHub não será executada; o crédito não é cobrado.
O CPF ou CNPJ informado não foi encontrado na base. Verifique o documento e tente novamente.

Authorizations

​
X-Api-Token
string
header
required

Chave de API para autenticação. Envie o token no header X-Api-Token.

Body

application/json
​
document
string
required

CPF (11 dígitos) ou CNPJ (14 caracteres) sem formatação. A partir de jul/2026 o CNPJ pode ser alfanumérico: 12 caracteres (A-Z maiúsculo / 0-9) + 2 dígitos verificadores numéricos.

Required string length: 11 - 14
Pattern: ^[0-9]{11}$|^[A-Z0-9]{12}[0-9]{2}$
Example:

"12345678901"

​
documentIdentity
string

Documento de identidade (RG) - opcional, apenas para CPF

Required string length: 6 - 15
Example:

"MG12345678"

​
districts
object[]

Lista de distritos onde as certidões devem ser emitidas. Obrigatório exceto quando creditAnalysisOnly é true. Máximo 2 distritos.

Required array length: 1 - 2 elements
Example:
​
creditAnalysis
boolean
default:false

Se deve incluir análise de crédito (Serasa) além das certidões. Adiciona 0,5 créditos ao custo. Só é realizada se o titular tiver 18+ anos.

​
creditAnalysisOnly
boolean
default:false

Se true, realiza apenas análise de crédito sem emitir certidões. Distritos não são obrigatórios. Titular deve ter 18+ anos.

​
useOldModel
boolean
default:false

Se deve usar o modelo antigo de relatório de análise de crédito (true) ou o novo modelo de aluguel (false). Aplica-se apenas a requisições de análise de crédito. Modelos: antigo usa CREDIT_ANALYSIS_PF/PJ, novo usa CREDIT_ANALYSIS_PF_RENT/PJ_RENT

Response

Diligência criada com sucesso

​
diligenceId
string

Identificador único da diligência criada

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
message
string
Example:

"Diligence emitted successfully"