Skip to main content
GET
Consultar análise

Authorizations

Authorization
string
header
required

Chave de API do workspace (prefixo slhk_), enviada no header: Authorization: Bearer slhk_sua_chave_aqui

Headers

x-request-id
string

Identificador de rastreio opcional fornecido pelo cliente. Gerado pelo servidor se omitido; ecoado no header da resposta.

Path Parameters

id
string<uuid>
required

UUID da análise (campo id da resposta do POST).

Response

Estado atual da análise. Header Retry-After presente apenas em estados não-terminais (pending/running).

id
string<uuid>
required

UUID da análise.

status
enum<string>
required

Estado do ciclo de vida da análise.

Available options:
pending,
running,
completed,
failed
subject_type
enum<string>
required

Tipo do analisado.

Available options:
pj,
pf
document
string
required

Documento (CNPJ/CPF) analisado, apenas dígitos.

created_at
string<date-time>
required

Timestamp ISO 8601 de criação.

verdict
enum<string> | null

Veredito final de risco; null enquanto pending/running. incompleto = algum bloco ficou unavailable (ver coverage).

Available options:
aprovado,
alerta,
reprovado,
incompleto
blocks
object[] | null

Resultados individuais dos blocos; null até a análise terminar.

coverage
object[] | null

Relatório de cobertura das fontes de dados; null até a análise terminar.

tokens_charged
number

Tokens debitados por esta análise.

balance
number

Saldo de tokens do workspace após o débito.

finished_at
string<date-time> | null

Timestamp ISO 8601 de término (completed ou failed); null enquanto em andamento.

poll_after_seconds
number

Segundos a aguardar antes do próximo poll. Presente apenas em estados não-terminais (pending/running).

request_id
string

Identificador da requisição para rastreio e suporte.