> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # API de atualização de utilizador: entidade do fornecedor > Atualize os campos de utilizador da Didit editáveis: nome de apresentação, metadados e etiquetas. Os campos de identidade verificados são imutáveis. Atualizar prompt do utilizador Copiar o prompt para a área de transferência \

\`Goal: Partial-update a Didit User entity by vendor_data.

Endpoint: PATCH https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: 
Content-Type: application/json

Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.

Request body (PARTIAL — only included fields are touched; auto-derived counters and session history are left alone):
\- full_name (string, max 512, nullable)
\- display_name (string, nullable)
\- date_of_birth (string YYYY-MM-DD, nullable)
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Setting "BLOCKED" auto-adds vendor_data to the system blocklist; flipping away removes it.
\- metadata (object, nullable) — REPLACES existing metadata wholesale; merge client-side if you only want to add keys.
\- approved_emails (object)
\- approved_phones (object)
\- issuing_states (object)
\- reason (string, optional, max 1000): why the status changed. Recorded as the comment of the STATUS_CHANGED entry in the user's activity (comments[].comment), only when this update actually changes status. Webhooks do not carry it.

curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Jane S.", "status": "FLAGGED", "reason": "Address does not match the billing country"}'

Response 200: full updated UserDetailItem (same shape as GET). See /reference/data-models.

Side effects:
\- Writes to the user's comments activity log (actor derived from the API key): a STATUS_CHANGED entry with reason when status changes, and a PROFILE_UPDATED entry when display_name, full_name, date_of_birth or metadata change.
\- last_activity_at bumped to now().
\- Concurrent updates: last-write-wins per field.
\- Re-sending an unchanged body is safe (no extra audit row).

Failure modes:
\- 400 — validation. Examples:
\{ "status": ["Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED"] }
\{ "metadata": ["Metadata must be a JSON object."] }
date_of_birth must be YYYY-MM-DD.
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key. { "detail": "Authentication credentials were not provided." }
\- 403 — the API key is revoked or is not valid for this application. { "detail": "You do not have permission to perform this action." }
\- 403: a scoped API key without users write. { "detail": "This API key has no write access to people." }
\- 404 — vendor_data not found. { "detail": "Not found." }
\- 429 — rate-limited.

Notes:
\- vendor_data in the URL itself cannot be changed via this endpoint — create new + delete old to rekey.
\- For status-only flips, prefer the dedicated PATCH /v3/users/{vendor_data}/update-status/.
\- Overriding fields populated by a verified session is allowed but flagged in the audit log.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Colar em ## Visão geralAtualiza os campos editáveis de uma [entidade Utilizador](https://docs.didit.me/pt/entities/users/overview.md). 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](https://docs.didit.me/pt/management-api/users/update-status.md). É 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](https://docs.didit.me/pt/console/audit-logs.md).## PermissõesO segredo principal e as [chaves de API](https://docs.didit.me/pt/console/api-keys.md) 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](https://docs.didit.me/pt/console/roles-permissions.md) 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- [Operações de utilizadores](https://docs.didit.me/pt/entities/users/operations.md) - [Modelo de dados](https://docs.didit.me/pt/entities/users/data-model.md) - [Atualizar estado](https://docs.didit.me/pt/management-api/users/update-status.md) ## OpenAPI ````yaml pt/openapi-25.json PATCH /v3/users/{vendor_data}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/users/{vendor_data}/: patch: tags: - Users summary: Atualizar utilizador description: >- Atualização parcial de um utilizador: `display_name`, `full_name`, `date_of_birth`, `status`, `metadata`, `approved_emails`/`approved_phones`/`issuing_states`. `metadata` substitui completamente. Alterar o `status` aqui funciona como [Update User Status](#patch-/v3/users/-vendor_data-/update-status/): regista uma atividade `STATUS_CHANGED` com o `reason` opcional, e `BLOCKED` adiciona os `vendor_data` à lista de bloqueio do sistema (alterar para outro valor diferente de `BLOCKED` remove essa entrada). Alterações a `display_name`, `full_name`, `date_of_birth` ou `metadata` são registadas como uma atividade `PROFILE_UPDATED`. operationId: update_user parameters: - name: vendor_data in: path required: true schema: type: string description: >- O seu identificador exclusivo para o utilizador (string de formato livre, NÃO um UUID). example: user-abc-123 requestBody: content: application/json: schema: type: object properties: full_name: type: string nullable: true maxLength: 512 description: Nome completo do utilizador display_name: type: string nullable: true description: Nome de apresentação personalizado para este utilizador date_of_birth: type: string format: date nullable: true description: Data de nascimento no formato YYYY-MM-DD status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- 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). metadata: type: object nullable: true description: >- 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: type: array items: type: string description: >- Endereços de e-mail verificados para este utilizador, por exemplo, `["john@example.com"]`. Substitui totalmente a lista armazenada. approved_phones: type: array items: type: string description: >- Números de telefone verificados para este utilizador. Substitui totalmente a lista armazenada. issuing_states: type: array items: type: string description: >- Países emissores (ISO 3166-1 alfa-3), por ex. `["USA"]`. Substitui totalmente a lista guardada. reason: type: string nullable: true maxLength: 1000 description: >- 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. examples: Rename: summary: Definir nome de apresentação value: display_name: Jane S. Override status: summary: Sinalizar o utilizador para revisão value: status: FLAGGED Add metadata: summary: Substituir JSON de metadados value: metadata: tier: premium risk_level: low Fix extracted DOB: summary: Campos de perfil extraídos corretos value: full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' Flag with reason: summary: Sinalizar o utilizador e registar o motivo value: status: FLAGGED reason: Address does not match the billing country responses: '200': description: >- Utilizador atualizado. É devolvido o registo completo e atualizado do utilizador (mesma estrutura que Obter utilizador). content: application/json: schema: $ref: '#/components/schemas/UserDetailItem' examples: Updated: value: didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: Jane S. full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' effective_name: Jane S. status: FLAGGED metadata: tier: premium portrait_image_url: https:///... session_count: 3 approved_count: 2 declined_count: 0 in_review_count: 1 issuing_states: - USA approved_emails: - john@example.com approved_phones: - '+14155551234' features: ID_VERIFICATION: Approved LIVENESS: Approved FACE_MATCH: Approved AML: Approved features_list: - feature: ID_VERIFICATION status: Approved - feature: LIVENESS status: Approved - feature: FACE_MATCH status: Approved - feature: AML status: Approved last_session_at: '2025-06-15T10:30:00Z' last_activity_at: '2025-06-15T10:30:00Z' first_session_at: '2025-06-01T08:00:00Z' tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d tag: uuid: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b name: VIP color: '#2567FF' description: null source: custom created_at: '2025-05-01T09:00:00Z' updated_at: '2025-05-01T09:00:00Z' added_by_email: analyst@acme.com added_by_name: Jane Analyst created_at: '2025-06-02T11:00:00Z' comments: [] created_at: '2025-06-01T08:00:00Z' updated_at: '2025-06-15T10:30:00Z' '400': description: >- Corpo inválido — normalmente um `status` desconhecido ou uma `date_of_birth` que não está em `YYYY-MM-DD`. content: application/json: examples: Bad status: value: status: - '"INVALID" is not a valid choice.' Bad date_of_birth: value: date_of_birth: - >- Date has wrong format. Use one of these formats instead: YYYY-MM-DD. Reason too long: value: reason: - Ensure this field has no more than 1000 characters. '401': description: >- Nenhuma credencial fornecida. Os pedidos para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitados pelo middleware de autenticação antes de chegarem à API. content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- A chave não pode atualizar utilizadores para esta aplicação. Uma chave em falta devolve `403`; uma chave incorreta, revogada ou expirada devolve `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- Não existe nenhum utilizador com o `vendor_data` fornecido para esta aplicação. content: application/json: examples: Not found: value: detail: Not found. '429': description: >- Limite de pedidos excedido; reduza a frequência e tente novamente após o intervalo indicado em `Retry-After`. content: application/json: examples: Rate limited: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"display_name": "Jane S.", "status": "FLAGGED"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.update( "user-abc-123", display_name="Jane S.", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.users.update("user-abc-123", { display_name: "Jane S.", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Update(ctx, \"user-abc-123\", didit.UsersUpdateParams{\n\tDisplayName: didit.String(\"Jane S.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.UsersUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().update("user-abc-123", UsersUpdateParams.builder() .displayName("Jane S.") .build()); System.out.println(result); - lang: php label: PHP source: |- users->update('user-abc-123', [ 'display_name' => 'Jane S.', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.update( "user-abc-123", display_name: "Jane S." ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Users.UpdateAsync("user-abc-123", new UsersUpdateParams { DisplayName = "Jane S.", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: UserDetailItem: type: object description: >- Detalhe completo do utilizador. Estende UserListItem com metadados, comentários e updated_at. allOf: - $ref: '#/components/schemas/UserListItem' - type: object properties: metadata: type: object description: >- JSON de metadados personalizados que associou a este utilizador. O valor predefinido é `{}`. tags: type: array description: >- 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. items: type: object properties: uuid: type: string format: uuid description: UUID da atribuição de etiqueta (não da etiqueta em si). tag: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: type: string nullable: true source: type: string enum: - didit - custom created_at: type: string format: date-time updated_at: type: string format: date-time added_by_email: type: string nullable: true added_by_name: type: string nullable: true created_at: type: string format: date-time comments: type: array items: type: object properties: uuid: type: string format: uuid comment_type: type: string enum: - COMMENT - STATUS_CHANGED - METADATA_UPDATED - TAG_ADDED - TAG_REMOVED - PROFILE_UPDATED comment: type: string nullable: true actor_email: type: string nullable: true actor_name: type: string nullable: true previous_status: type: string nullable: true enum: - ACTIVE - FLAGGED - BLOCKED - null new_status: type: string nullable: true enum: - ACTIVE - FLAGGED - BLOCKED - null previous_value: type: object nullable: true description: >- Valores anteriores dos campos para entradas PROFILE_UPDATED. new_value: type: object nullable: true description: Novos valores de campo para entradas PROFILE_UPDATED. changed_fields: type: array items: type: string description: >- Nomes dos campos alterados por uma entrada PROFILE_UPDATED. metadata: type: object nullable: true mentioned_emails: type: array items: type: string created_at: type: string format: date-time description: >- Registo de atividade e comentários para este utilizador (alterações de estado, edições de perfil, notas manuais). updated_at: type: string format: date-time UserListItem: type: object description: Um utilizador verificado. properties: didit_internal_id: type: string format: uuid description: UUID interno estável da Didit para este utilizador. vendor_data: type: string nullable: true description: >- 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: type: string nullable: true description: Nome de apresentação personalizado definido por si full_name: type: string nullable: true description: Nome completo extraído de documentos verificados date_of_birth: type: string format: date nullable: true effective_name: type: string nullable: true description: >- Melhor nome disponível: display_name se definido, caso contrário full_name status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- 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`. portrait_image_url: type: string nullable: true description: >- URL pré-assinado da fotografia de retrato do utilizador (expira após algumas horas) session_count: type: integer description: Número total de sessões de verificação para este utilizador approved_count: type: integer description: Número de sessões aprovadas declined_count: type: integer description: Número de sessões recusadas in_review_count: type: integer description: Número de sessões em análise issuing_states: type: array items: type: string description: >- 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: type: array items: type: string description: >- Endereços de e-mail verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Números de telefone verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, `["+14155551234"]`. features: type: object description: >- 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: type: array items: type: object properties: feature: type: string status: type: string description: >- Os mesmos dados que `features`, como um array ordenado de objetos `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Carimbo de data/hora da sessão mais recente first_session_at: type: string format: date-time nullable: true description: Carimbo de data/hora da primeira sessão last_activity_at: type: string format: date-time nullable: true description: >- Carimbo de data/hora da atividade mais recente neste utilizador (sessão, transação, mudança de estado, edição de dados, etc.). tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Etiquetas atribuídas a este utilizador created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.