Skip to main content
GET
Obter status de um run

Authorizations

x-api-key
string
header
required

API key no header x-api-key (recomendado)

Headers

x-kycert-api-version
string
Example:

"2026-06-03"

Path Parameters

run_id
string<uuid>
required

ID do run retornado pelo POST /runs

Response

Run finalizado — resultado disponível

run_id
string<uuid>
status
enum<string>

Status atual do run:

  • queued / pending / running — em processamento
  • completed — finalizado com resultado
  • blocked — bloqueado por regra crítica
  • pending_review — aguardando análise manual do compliance officer
  • partial — resultado parcial (algumas fontes falharam)
  • failed — falha técnica — reenvie o run
Available options:
queued,
pending,
running,
completed,
blocked,
pending_review,
partial,
failed
decision
enum<string> | null

Decisão do bureau:

  • approved — aprovado para prosseguir
  • rejected — bloqueado por regra crítica (run com status blocked)
  • review — requer análise manual do compliance officer
  • null — run ainda em andamento ou com falha técnica
Available options:
approved,
rejected,
review
operative_decision
enum<string> | null

Decisão operacional — difere de decision apenas quando fontes tier-1 falharam por erro técnico durante a execução.

Valores possíveis: approved, rejected, hold, null.

  • hold — fontes críticas não concluíram; resultado incerto (ver /analysis para detalhes)
  • rejected — fonte crítica retornou INVALID com bloqueio
  • approved — todas as fontes críticas concluíram sem restrição

Quando operative_decision é null: run_analysis ainda não foi gerado — tratar decision como definitivo.

Available options:
approved,
rejected,
hold
risk_band
enum<string> | null

Classificação de risco calculada pelo engine:

  • baixo — risco baixo, sem apontamentos relevantes
  • medio — risco médio, apontamentos de pendência identificados
  • alto — risco alto, apontamentos críticos identificados
  • null — run ainda não concluído
Available options:
baixo,
medio,
alto
external_id
string | null
metadata
object | null
created_at
string<date-time>
completed_at
string<date-time> | null
template_name
string | null

Nome do template usado neste run

summary_message
string | null

Mensagem human-readable da decisão gerada pelo engine

manual_review
boolean

true quando o run está aguardando revisão manual do compliance officer

livemode
boolean