Users

Consultar o enrollment biométrico

Informa se o usuário tem enrollment e até quando.

A imagem de referência é apagada por ciclo de vida do S3 90 dias após o cadastro, mas o registro do enrollment permanece. Quem só pergunta "esse usuário está cadastrado?" recebe sim muito depois da foto ter sumido, e descobre o problema como um 422 no meio da assinatura. expiresAt e expired existem para permitir uma varredura de recadastramento antes disso.

O CPF volta mascarado: a rota é enumerável por userExternalId.

Requer scope transactions:read.

get/v1/users/{userExternalId}/enrollment

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/users/{userExternalId}/enrollment
  • Auth: HTTP bearer

Path parameters

userExternalIdstring required

Identificador do usuário no sistema do integrador.

Response

Enrollment encontrado.

userExternalIdstring
enrollmentSource'ORGANIZATION_PROVIDED' | 'FIRST_LIVENESS' | 'DOCUMENT_PHOTO' | 'BANK_PROVIDED'

Origem do cadastro em vigor, sempre na forma canônica — enviar BANK_PROVIDED devolve ORGANIZATION_PROVIDED. Cadastros feitos antes de setembro de 2026 podem devolver BANK_PROVIDED.

enrollmentVersioninteger

Incrementa a cada novo PUT para o mesmo usuário.

enrollmentHashstring

SHA-256 da imagem de referência em vigor.

enrolledAtstring date-time
expiresAtstring date-time

Momento em que a imagem de referência é apagada pelo ciclo de vida do S3 (enrolledAt + retentionDays). Depois disso a etapa de comparação falha com 422 até haver novo cadastro.

expiredboolean

true quando expiresAt já passou — recadastre.

O registro sobrevive à imagem de propósito, por 30 dias, justamente para que uma varredura de recadastramento encontre expired: true. Passada essa folga o registro também é apagado, e a mesma consulta passa a responder 404 — que é indistinguível de "nunca cadastrado". Quem depende disso deve varrer dentro da folga, não depois.

retentionDaysinteger

Janela de retenção de dados biométricos, em dias.

maskedCpfstring

Últimos 4 dígitos do CPF, prefixados por ***.

faceConfidencenumber double

Confiança da detecção facial no momento do cadastro (0-100).

documentImageHashstring

Presente apenas em enrollment com source: DOCUMENT_PHOTO.

Example response

{
  "retentionDays": 90,
  "maskedCpf": "***8901"
}

Changes

No recorded changes to this operation across all 1 revision of this API.