Pular para o conteúdo principal
PATCH
curl

Visão geral

Atualiza os campos mutáveis de uma entidade de usuário. Os campos propagados de sessões verificadas de Verificação de Usuário (KYC) (full_name, date_of_birth, portrait_image, contadores agregados, features) são somente para leitura.

Quando usar

  • Atualizar seus próprios metadados: mover um usuário entre níveis, alterar tags, registrar uma nota interna.
  • Renomear: definir um display_name melhor para as visualizações internas do console.
  • Substituir dados verificados (com cautela): substituições manuais são permitidas, mas ficam registradas na trilha de auditoria.

Observações

  • O vendor_data na URL não pode ser alterado por este endpoint. Crie um novo usuário e exclua o antigo se precisar trocar a chave.
  • Emite um webhook user.data.updated com um array changed_fields para que os consumidores possam sincronizar com eficiência.
  • Uma alteração de status aqui funciona como Atualizar status do usuário. Ela fica registrada 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 o reason.
  • Se você fizer um PATCH em um campo que está sendo gerenciado por uma sessão verificada, a substituição será aceita, mas sinalizada no registro de auditoria.

Permissões

O segredo principal e as chaves de API com acesso total sempre podem chamar este endpoint. Uma chave com acesso personalizado precisa de permissão de escrita em Pessoas (users). Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue acessar este endpoint. As funções e permissões do Console determinam o que um membro da equipe pode fazer no Console. Elas não são avaliadas em requisições feitas com chave de API.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

vendor_data
string
obrigatório

Seu identificador exclusivo do usuário (string livre, NÃO um UUID).

Corpo

application/json
full_name
string | null

Nome completo do usuário

Maximum string length: 512
display_name
string | null

Nome de exibição personalizado para este usuário

date_of_birth
string<date> | null

Data de nascimento no formato YYYY-MM-DD

status
enum<string>

Status do ciclo de vida do usuário. Uma alteração é registrada como uma atividade STATUS_CHANGED, e BLOCKED adiciona o vendor_data à lista de bloqueio do sistema (sair de BLOCKED remove essa entrada).

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

Objeto JSON arbitrário que você anexa ao usuário. Substitui totalmente os metadados existentes na atualização — faça a mesclagem no lado do cliente se quiser apenas adicionar chaves.

approved_emails
string[]

Endereços de e-mail verificados deste usuário, por exemplo, ["john@example.com"]. Substitui completamente a lista armazenada.

approved_phones
string[]

Números de telefone verificados deste usuário. Substitui completamente a lista armazenada.

issuing_states
string[]

Países emissores (ISO 3166-1 alpha-3), por exemplo ["USA"]. Substitui integralmente a lista armazenada.

reason
string | null

Por que o status mudou. Registrado na entrada de mudança de status na atividade do usuário (comments[].comment e Activity no Business Console), apenas quando o status realmente muda. Os webhooks não o incluem.

Maximum string length: 1000

Resposta

Usuário atualizado. Retorna o registro completo e atualizado do usuário (mesmo formato de Get User).

Detalhes completos do usuário. Estende UserListItem com metadados, comentários e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para este usuário.

vendor_data
string | null

Seu identificador exclusivo deste usuário (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado.

display_name
string | null

Nome de exibição personalizado definido por você

full_name
string | null

Nome completo extraído dos 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>

Status do ciclo de vida do registro do usuário (NÃO é um status de sessão). ACTIVE é o padrão, FLAGGED marca o usuário para atenção manual e BLOCKED impede novas sessões para este vendor_data.

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

URL pré-assinada da foto de retrato do usuário (expira após algumas horas)

session_count
integer

Número total de sessões de verificação deste usuário

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 revisão

issuing_states
string[]

Códigos ISO 3166-1 alpha-3 dos países emissores encontrados nos documentos de identidade aprovados deste usuário, por exemplo, ["USA", "ESP"]. Array vazio quando não houver nenhum.

approved_emails
string[]

Endereços de e-mail verificados coletados das sessões aprovadas deste usuário, por exemplo, ["john@example.com"].

approved_phones
string[]

Números de telefone verificados coletados das sessões aprovadas deste usuário, por exemplo, ["+14155551234"].

features
object

Status agregado por recurso em todas as sessões deste usuário. 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 de features, como um array ordenado de objetos {feature, status}.

last_session_at
string<date-time> | null

Data e hora da sessão mais recente

first_session_at
string<date-time> | null

Data e hora da primeira sessão

last_activity_at
string<date-time> | null

Data e hora da atividade mais recente deste usuário (sessão, transação, mudança de status, edição de dados etc.).

tags
object[]

Atribuições de tags. OBSERVAÇÃO: nas respostas de detalhe, cada entrada é um objeto de vínculo de tag ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), diferente do formato plano {uuid, name, color} usado nas respostas de lista.

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que você anexou a este usuário. O padrão é {}.

comments
object[]

Registro de atividades e comentários deste usuário (alterações de status, edições de perfil, notas manuais).

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