Skip to main content
GET
Obter sessão biométrica atual

Visão geral

Este endpoint retorna a sessão biométrica mais recente de uma entidade (por createdAt), independente do status: pending, in_progress, approved, rejected, etc. É o equivalente biométrico de GET /api/kyc/entities/{entityId}/current para validações KYC.
Se a entidade nunca teve sessão biométrica, a API responde 200 com null (não 404), igual ao endpoint KYC atual.

Quando usar

  • Recuperar uma sessão pendente para reembarcar o sessionUrl ou cancelá-la
  • Consultar o status da última tentativa biométrica (status, rejectionCode, decision)
  • Resolver ACTIVE_SESSION_EXISTS ao criar nova sessão: o id da sessão ativa está neste endpoint (ou em activeSessionId no erro 409)

Solicitação

Cabeçalhos

Resposta

200 OK — sessão encontrada

200 OK — sem sessões

Fluxo recomendado

  1. POST /api/kyc/biometric/sessions → guardar id e sessionUrl
  2. Embarcar sessionUrl em iframe
  3. Polling: GET /api/kyc/biometric/entities/{entityId}/current ou GET /api/kyc/biometric/sessions/{id}
  4. Para reiniciar: POST /api/kyc/biometric/sessions/{id}/cancel (apenas pending / in_progress)

Diferença do currentSessionId na listagem

GET /api/kyc/biometric/sessions?entityId=... inclui currentSessionId: a última sessão approved (verificação biométrica vigente). Este /current retorna a última sessão criada, que pode estar pending.

Erro ao criar segunda sessão

Se tentar criar outra sessão com uma ativa (pending / in_progress), recebe 409 ACTIVE_SESSION_EXISTS com o ID bloqueante:
Cancele com POST /api/kyc/biometric/sessions/{activeSessionId}/cancel e crie novamente.

Relacionados