Skip to main content
POST
Criar análise
Para menor latência, reutilize a conexão HTTP entre chamadas. Veja Recomendação para baixa latência.

Authorizations

X-API-Key
string
header
required

Body

application/json
document
string | null

CPF válido ou CNPJ numérico/alfanumérico do subject.

Maximum string length: 32
entity_id
integer | null

Id numérico da entidade a analisar.

Required range: x > 0
source
string | null

Identificador livre da origem da chamada.

Maximum string length: 128

Response

Successful Response

uuid
string<uuid>
required
elapsed_ms
integer | null

Tempo, em milissegundos inteiros, que o servidor gastou NESTA requisição, da entrada até a resposta montada (não inclui rede entre o cliente e o servidor). No GET é o tempo daquele GET, não o do POST original. Nulo apenas fora do ambiente que mede o tempo.

origin
AnalysisOrigin · object | null

Who asked for the analysis. Null only on rows with no known owner.

risk
AnalysisRiskSummary · object | null
score_status
enum<string>
default:scored

'scored': análise pontuada (risk preenchido). 'not_scored': não há pontuação para este documento; risk é nulo, não há sinais e nenhum crédito é consumido.

Available options:
scored,
not_scored
subject
SubjectProfile · object | null