Saltar para o conteúdo principal
DELETE

​
Suporte a KYC e KYB

Funciona para sessões de Verificação de utilizadores (KYC) e de Verificação de empresas (KYB). O session_id é resolvido nos dois tipos de sessão, e o comportamento de eliminação é o mesmo para ambos. A retenção do template biométrico aplica-se apenas às sessões KYC, porque só estas incluem um embedding facial.

​
Comportamento

  • A sessão é eliminada juntamente com todas as tentativas de verificação que contém, incluindo os resultados substituídos por uma nova submissão: a sua decisão, os dados extraídos, os registos das funcionalidades associadas (verificações de identidade, consultas a registos de empresas, documentos, AML, análise de IP e assim por diante), as respetivas revisões e o registo de atividade, e todos os ficheiros armazenados.
  • Eliminar uma sessão de Verificação de empresas (KYB) elimina também, de forma recursiva, as verificações que esta criou para as suas pessoas-chave (KYC) e para os seus proprietários da empresa (KYB). A resposta indica o número de verificações eliminadas em deleted_child_verifications. Uma verificação à qual a sessão apenas está ligada, como um KYC aprovado já existente que foi reutilizado, não é eliminada.
  • Os dados de assinatura eletrónica são eliminados em conjunto: os documentos a assinar e os respetivos ficheiros Word originais, os PDF assinados, os PDF de prova, as imagens de assinatura e todos os valores dos campos. Os respetivos caminhos de transferência devolvem 404.
  • A sessão deixa de aparecer imediatamente nas respostas de listagem e de decisão, e os URLs de multimédia emitidos antes da chamada deixam de funcionar.
  • As entregas de webhook ainda em fila para a sessão, bem como as respetivas novas tentativas, são descartadas.
  • A monitorização AML contínua e a monitorização do registo de empresas KYB iniciadas pelas verificações eliminadas terminam.
  • A eliminação é permanente e irreversível. Não existe endpoint de restauro, por isso exporte tudo o que precisar, como um PDF de decisão, antes de chamar este endpoint.
  • A resposta é 200 OK, enviada apenas depois de a eliminação estar concluída, com um corpo JSON que indica o que aconteceu aos dados biométricos faciais da sessão. Consulte a Migração se o seu cliente ainda esperar 204.

​
Dados num relatório regulatório finalizado

Se a sessão fizer parte de um caso com um relatório regulatório finalizado, o pedido devolve 409 e nada é eliminado. A resposta usa code: in_filed_report e indica cada relatório:
Elimine cada relatório com Eliminar relatório e, em seguida, repita a eliminação. Eliminar o relatório não elimina a sessão; a sessão permanece até voltar a chamar este endpoint.

​
Dados biométricos faciais: eliminar ou conservar

Cada sessão KYC com uma selfie de prova de vida contém um embedding facial que alimenta a Pesquisa facial 1:N e a deteção de duplicados. Por predefinição, esse embedding é eliminado com a sessão (face_retention_policy: delete_with_session), para que uma pessoa cuja sessão tenha sido eliminada possa voltar a verificar-se sem ser sinalizada como duplicado. As aplicações que precisem de manter a deteção de duplicados após a eliminação de uma sessão podem optar pela conservação do template biométrico. Nesse caso, a Didit elimina a sessão e todos os seus dados, como habitualmente, e mantém um único template biométrico facial, sem imagens e gerido em separado, associado ao Utilizador da sessão.
Um template biométrico conservado é um dado biométrico. Não é anónimo, não é transitório e não é eliminado com a sessão. Mantém-se até à sua data de expiração agendada, até um prazo anterior imposto pela lei aplicável, até à eliminação do Utilizador, até um pedido de eliminação por motivos de privacidade ou até uma purga explícita. Ative a conservação apenas quando a instrução que dá enquanto responsável pelo tratamento e o seu aviso de privacidade a abrangerem.
O que um template conservado contém e o que nunca contém: A conservação é configurada em três locais, do mais abrangente ao mais específico:
  1. Política da aplicação em Business Console → App Settings → Data retention ou através de PATCH /v3/webhook/ (face_retention_policy, face_retention_days). Consulte Conservação de dados.
  2. Substituição por pedido com retain_face_embeddings neste endpoint e em Batch Delete Sessions.
  3. Classe de instrução com deletion_instruction. Uma instrução privacy_erasure tem sempre prioridade: purga todos os templates conservados desse Utilizador e nunca conserva um novo.

​
Corpo do pedido

Todos os campos são opcionais. Omita o corpo para seguir a política da aplicação.

​
Resposta

A resposta confirma que a Didit aceitou e aplicou a sua instrução de eliminação. Não é um certificado de eliminação: guarde o instruction_id no seu próprio registo de eliminações para poder correlacionar mais tarde o registo de auditoria.

​
Duração da conservação e expiração

Cada template conservado tem um expires_at finito. A Didit define-o como o prazo mais curto de entre os seguintes:
  1. face_retention_days do pedido ou, quando o pedido o omite, o face_retention_days da aplicação;
  2. a janela geral de conservação de dados da aplicação, quando estiver configurada;
  3. face_retention_deadline do pedido, quando for fornecido.
Um pedido que conservaria um template sem qualquer duração finita é rejeitado com 400 e nada é eliminado. Os templates conservados não podem ultrapassar o que ocorrer primeiro entre a instrução aplicável do cliente, o fim da finalidade, a expiração configurada, a instrução de eliminação do titular dos dados e o prazo legal aplicável aos dados biométricos. É responsável por escolher uma duração que cumpra as leis aplicáveis aos seus utilizadores; escolha uma mais curta sempre que uma regra aplicável o exija.

​
Eliminação por motivos de privacidade

Envie deletion_instruction: "privacy_erasure" quando estiver a agir sobre um pedido do titular dos dados. A Didit purga todos os templates biométricos conservados associados ao utilizador da sessão e, em seguida, elimina a sessão e o seu embedding facial. A política de conservação da aplicação não pode sobrepor-se a uma instrução de eliminação por motivos de privacidade, e retain_face_embeddings: true é rejeitado com 400. Eliminar o utilizador com Eliminar utilizadores em lote também purga os templates conservados associados.

​
O que não é afetado

Eliminar uma sessão não limpa estes dados por si. Se estiver a tratar um pedido de direito ao apagamento, trate-os separadamente.
  • Entradas da lista de bloqueio criadas a partir da sessão (facial ou de documento) permanecem no lugar. Remova-as da lista de bloqueio. Uma entrada facial na lista de bloqueio mantém a sua própria entrada biométrica, independente de qualquer template conservado.
  • Tokens de partilha já emitidos para a sessão não são revogados, mas não há nada que possam importar: uma importação com um desses tokens devolve 400 com {"share_token": ["Original session does not exist."]}.
  • Webhooks já entregues para a sessão não são afetados. As entregas ainda em fila, e as respetivas tentativas, são descartadas. Não é emitido nenhum webhook pela própria eliminação.
  • Créditos já consumidos pela verificação não são reembolsados.
  • Cópias assinadas já enviadas por e-mail a um signatário através de um passo de Assinatura eletrónica estão na caixa de correio do signatário e não são afetadas.
  • A entidade principal Utilizador ou Empresa não é eliminada. Use Eliminar utilizadores ou Eliminar empresas para as eliminar. Se o retrato de perfil do utilizador tiver vindo da sessão eliminada, o retrato é removido.
  • Um template biométrico conservado (apenas se tiver optado por isso) mantém-se até expirar ou até o purgar. Purgue-o com a API de templates biométricos, eliminando o utilizador, ou repetindo a eliminação de outra sessão do mesmo utilizador com deletion_instruction: "privacy_erasure".

​
Exemplos

Resposta numa aplicação que não optou por esta opção:

​
Erros

Com 400, nada é eliminado. Com 503, a sessão continua no lugar: repita o mesmo pedido até devolver 200. Alguns dos seus ficheiros armazenados ou o seu embedding facial podem já ter sido eliminados, por isso não dependa deles após um 503.

​
Permissão

É necessária a permissão delete:sessions. A mesma permissão abrange as sessões de Verificação de utilizadores (KYC) e de Verificação de empresas (KYB), bem como a substituição da política de conservação.

​
Eliminação em lote

Para operações em massa sobre sessões KYC, use POST /v3/sessions/delete/. Aceita os mesmos campos de conservação e de instrução. Até 20 sessões correspondentes são eliminadas no pedido, com um resultado por sessão; as restantes são processadas através de uma tarefa de eliminação. Consulte Eliminar sessões em lote.

​
Migração das respostas 204

Até esta versão, o endpoint devolvia 204 No Content. Passa agora a devolver 200 OK com o corpo JSON documentado acima, para que cada eliminação reporte o seu face_retention_outcome. Atualize os clientes que validam 204. O comportamento predefinido mantém-se: as aplicações existentes continuam em delete_with_session, e nenhuma migração ativa a conservação em seu nome. Ative-a explicitamente na Consola ou através de PATCH /v3/webhook/.

​
Relacionados

Autorizações

​
x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

​
sessionId
string<uuid>
obrigatório

UUID (session_id) da sessão de Verificação de utilizadores (KYC) ou de Verificação de empresas (KYB) a eliminar, conforme retornado aquando da criação da sessão. Tem de ser um UUID canónico com hífenes — um valor que não seja UUID não corresponde à rota e devolve 404.

Exemplo:

"11111111-2222-3333-4444-555555555555"

Corpo

application/json

Opcional. Omita totalmente o corpo para seguir a política de conservação da aplicação com uma eliminação operacional.

​
retain_face_embeddings
boolean | null

Substitui a face_retention_policy da aplicação para esta eliminação. true mantém um template biométrico facial sem imagem associado ao utilizador da sessão após a sessão ser eliminada; false elimina o embedding facial com a sessão; omita ou use null para seguir a política da aplicação. Ignorado para sessões KYB e para sessões sem embedding facial.

Exemplo:

true

​
face_retention_days
integer

Duração finita de conservação, em dias, para um modelo conservado. Obrigatória quando um modelo é conservado, a menos que a aplicação já defina face_retention_days. O expires_at do modelo é determinado pelo limite mais cedo entre esta duração, a janela geral de conservação de dados da aplicação e face_retention_deadline.

Intervalo necessário: 1 <= x <= 3650
Exemplo:

365

​
face_retention_deadline
string<date-time>

Data de expiração definitiva opcional para um modelo retido. Tem de ser no futuro.

Exemplo:

"2027-08-28T00:00:00Z"

​
deletion_instruction
enum<string>
padrão:operational_session_delete

A classe de instrução que está a fornecer. operational_session_delete elimina a sessão e retém um modelo apenas quando a política ou retain_face_embeddings o determinar. privacy_erasure elimina permanentemente todos os templates biométricos retidos associados ao utilizador da sessão antes de eliminar a sessão, não pode ser substituído pela política da aplicação e não pode ser combinado com retain_face_embeddings: true (400).

Opções disponíveis:
operational_session_delete,
privacy_erasure
Exemplo:

"operational_session_delete"

​
instruction_id
string

A sua referência duradoura para esta instrução de eliminação (por exemplo, o id de um pedido de eliminação). Registada no registo de auditoria e em qualquer modelo retido. Gerada pela Didit quando omitida.

Maximum string length: 255
Exemplo:

"dsar-2026-0142"

Resposta

Sessão eliminada. O corpo indica o que aconteceu aos dados biométricos faciais da sessão e, para uma sessão KYB, quantas verificações criadas por esta foram eliminadas em conjunto.

​
session_id
string<uuid>

A sessão eliminada.

​
session_number
integer | null

O número da sessão eliminada.

​
face_retention_outcome
enum<string>

O que aconteceu aos dados biométricos faciais da sessão. deleted: o embedding facial foi eliminado com a sessão (predefinição). retained_with_user: a sessão é eliminada e um template biométrico sem imagem permanece associado ao Utilizador; consulte biometric_template_uuid. none: a sessão não tinha nenhum embedding facial (por exemplo, uma sessão de KYB ou uma sessão de KYC sem selfie de prova de vida). ineligible_no_vendor_user: a conservação foi solicitada, mas a sessão não tem nenhum Utilizador associado, pelo que o embedding foi eliminado com a sessão. Uma falha no armazenamento biométrico nunca é comunicada através deste campo neste endpoint: devolve 503 e a sessão não é eliminada.

Opções disponíveis:
retained_with_user,
deleted,
none,
ineligible_no_vendor_user
​
biometric_template_uuid
string<uuid> | null

ID do template biométrico retido quando face_retention_outcome é retained_with_user; null caso contrário. Faça a sua gestão através de /v3/biometric-templates/{template_uuid}/.

​
biometric_template_expires_at
string<date-time> | null

Quando o template biométrico retido é eliminado, quando face_retention_outcome é retained_with_user; null quando nenhum template é retido.

​
deleted_child_verifications
integer

Para uma sessão de Verificação de empresas (KYB): quantas verificações que ela criou (as sessões de KYC das suas pessoas-chave e as sessões de KYB dos seus proprietários empresariais, recursivamente) foram eliminadas juntamente com ela. Sempre 0 para uma sessão de KYC.

Última modificação em 7 de novembro de 2026