Skip to main content
POST

Quando usar

Use esta rota para iniciar a análise de um CPF ou CNPJ. A chamada é assíncrona: devolve o id do relatório na hora, com status PENDING, e a análise segue em segundo plano. Acompanhe pelo webhook REPORT_FINISHED ou consultando GET /v2/report/{id}.

Autenticação

Bearer JWT no header Authorization. A credencial precisa da permissão de criar relatórios pela API.

Corpo da requisição

O documento precisa combinar com a política: CNPJ numa política de CNPJ, CPF numa política de CPF. Caso contrário a resposta é 422.

Mesmo documento, mesma política, mesmo dia

Um relatório é identificado por documento, política, versão da política e dia. Repetir o POST com essa mesma combinação no mesmo dia não cria um segundo relatório: Isso protege contra relatório duplicado por retry. Para uma análise nova, use outro dia, outra política ou publique uma nova versão da política.
Se a resposta for 503 com reportId no corpo, o relatório já foi criado, mas a análise não pôde ser iniciada. Consulte esse reportId antes de tentar de novo.

Erros

Authorizations

Authorization
string
header
required

Enter JWT token

Body

application/json
policyId
string
required

Politica habilitada e de usage REPORT.

document
string
required

CPF ou CNPJ sem mascara. Digito verificador validado; CNPJ alfanumerico aceito.

type
string
deprecated

Ignorado. O tipo vem da politica.

months
integer

Meses de historico do SCR. Padrao: o da politica, depois o da organizacao, depois 12.

Response

Sucesso.

O relatorio criado. O processamento e assincrono: acompanhe pelo webhook REPORT_FINISHED ou por GET /v2/report/{id}. Mesmo documento, politica, versao e dia devolvem o mesmo relatorio.