Saltar para o conteúdo principal
PATCH
curl

Visão geral

Atualiza os campos editáveis de uma entidade Utilizador. Os campos propagados a partir de sessões de Verificação de utilizadores (KYC) verificadas (full_name, date_of_birth, portrait_image, contadores agregados, features) são só de leitura.

Quando usar

  • Atualizar os seus metadados: mudar um utilizador de nível, alterar etiquetas ou registar uma nota interna.
  • Mudar o nome: definir um display_name mais adequado para as vistas da Console voltadas para a equipa interna.
  • Substituir dados verificados (com cautela): as substituições manuais são permitidas, mas ficam registadas no registo de auditoria.

Notas

  • O vendor_data no URL não pode ser alterado através deste endpoint. Se precisar de mudar a chave, crie um novo utilizador e elimine o antigo.
  • Emite um webhook user.data.updated com um array changed_fields, para que os consumidores possam sincronizar de forma eficiente.
  • Uma alteração de status feita aqui funciona como Atualizar estado do utilizador. É registada na atividade da pessoa, com o reason opcional (até 1000 caracteres) como comentário, e BLOCKED adiciona o vendor_data à lista de bloqueio do sistema. O webhook user.status.updated não inclui reason.
  • Se fizer um PATCH a um campo atualmente gerido por uma sessão verificada, a substituição será aceite, mas fica assinalada no registo de auditoria.

Permissões

O segredo principal e as chaves de API de acesso total podem sempre chamar este endpoint. Uma chave com acesso personalizado precisa de permissão de escrita em Pessoas (users). Uma chave limitada a alguns fluxos ou apenas a sessões aprovadas não consegue aceder a este endpoint. As funções e permissões da Console determinam o que um membro da equipa pode fazer na Console. Não são avaliadas para pedidos feitos com chaves de API.

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

vendor_data
string
obrigatório

O seu identificador exclusivo para o utilizador (string de formato livre, NÃO um UUID).

Corpo

application/json
full_name
string | null

Nome completo do utilizador

Maximum string length: 512
display_name
string | null

Nome de apresentação personalizado para este utilizador

date_of_birth
string<date> | null

Data de nascimento no formato YYYY-MM-DD

status
enum<string>

Estado do ciclo de vida do utilizador. Uma alteração é registada como uma atividade STATUS_CHANGED, e BLOCKED adiciona o vendor_data à lista de bloqueio do sistema (mudar para um estado diferente de BLOCKED remove essa entrada).

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objeto JSON arbitrário que associa ao utilizador. Substitui totalmente os metadados existentes na atualização — faça a junção no lado do cliente se pretender apenas adicionar chaves.

approved_emails
string[]

Endereços de e-mail verificados para este utilizador, por exemplo, ["john@example.com"]. Substitui totalmente a lista armazenada.

approved_phones
string[]

Números de telefone verificados para este utilizador. Substitui totalmente a lista armazenada.

issuing_states
string[]

Países emissores (ISO 3166-1 alfa-3), por ex. ["USA"]. Substitui totalmente a lista guardada.

reason
string | null

O motivo da alteração de estado. Registado na entrada de alteração de estado da atividade do utilizador (comments[].comment e Activity na Business Console), apenas quando o estado realmente muda. Os webhooks não o transmitem.

Maximum string length: 1000

Resposta

Utilizador atualizado. É devolvido o registo completo e atualizado do utilizador (mesma estrutura que Obter utilizador).

Detalhe completo do utilizador. Estende UserListItem com metadados, comentários e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para este utilizador.

vendor_data
string | null

O seu identificador exclusivo para este utilizador (transmitido ao criar sessões). Pode ser nulo quando não tiver sido fornecido nenhum identificador de fornecedor.

display_name
string | null

Nome de apresentação personalizado definido por si

full_name
string | null

Nome completo extraído de documentos verificados

date_of_birth
string<date> | null
effective_name
string | null

Melhor nome disponível: display_name se definido, caso contrário full_name

status
enum<string>

Estado do ciclo de vida do registo do utilizador (NÃO é um estado da sessão). ACTIVE é o padrão, FLAGGED marca o utilizador para atenção manual, BLOCKED impede novas sessões para este vendor_data.

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL pré-assinado da fotografia de retrato do utilizador (expira após algumas horas)

session_count
integer

Número total de sessões de verificação para este utilizador

approved_count
integer

Número de sessões aprovadas

declined_count
integer

Número de sessões recusadas

in_review_count
integer

Número de sessões em análise

issuing_states
string[]

Códigos ISO 3166-1 alfa-3 dos países emissores observados nos documentos de identificação aprovados deste utilizador, por exemplo, ["USA", "ESP"]. Array vazio quando não houver nenhum.

approved_emails
string[]

Endereços de e-mail verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, ["john@example.com"].

approved_phones
string[]

Números de telefone verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, ["+14155551234"].

features
object

Estado agregado por funcionalidade em todas as sessões deste utilizador. Chaves possíveis: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valores possíveis: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Os mesmos dados que features, como um array ordenado de objetos {feature, status}.

last_session_at
string<date-time> | null

Carimbo de data/hora da sessão mais recente

first_session_at
string<date-time> | null

Carimbo de data/hora da primeira sessão

last_activity_at
string<date-time> | null

Carimbo de data/hora da atividade mais recente neste utilizador (sessão, transação, mudança de estado, edição de dados, etc.).

tags
object[]

Atribuições de etiquetas. NOTA: nas respostas detalhadas, cada entrada é um objeto de ligação de etiqueta ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), ao contrário do formato simples {uuid, name, color} utilizado nas respostas de listagem.

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que associou a este utilizador. O valor predefinido é {}.

comments
object[]

Registo de atividade e comentários para este utilizador (alterações de estado, edições de perfil, notas manuais).

updated_at
string<date-time>
Última modificação em 7 de novembro de 2026