Users

Apagar o enrollment biométrico

Elimina a imagem de referência, a imagem original do documento quando o cadastro veio de uma, e o registro do enrollment.

Existe para atender o direito de eliminação (LGPD art. 18): um funcionário que sai da empresa não deveria esperar os 90 dias de retenção para a face dele desaparecer.

Os objetos no S3 são removidos antes do registro, e cada remoção é gravada no log de acesso biométrico — essa entrada é a evidência de que o apagamento aconteceu.

Transações em andamento que dependiam desse enrollment passam a falhar a etapa de comparação com 422. É a consequência esperada de um pedido de eliminação.

Requer scope transactions:write.

delete/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 apagado.

userExternalIdstring
deletedboolean
deletedAtstring date-time
enrollmentVersioninteger

Versão que existia no momento do apagamento.

objectsDeletedinteger

Quantos objetos foram removidos (1, ou 2 com documento).

versionsDeletedinteger

Quantas versões foram destruídas. O bucket é versionado, e um DeleteObject comum só cria um marcador — os bytes continuariam recuperáveis por version id. Este número conta as versões efetivamente apagadas, e é o que comprova a eliminação.

Changes

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