> ## 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.
# Atualizar estado do utilizador: bloquear ou sinalizar
> Bloqueie, sinalize ou ative um utilizador na Didit. O estado aplica-se às futuras sessões KYC e à triagem de transações. Pagamento por chamada.
Prompt de atualização do estado do utilizador
Copiar o prompt para a área de transferência
\
\`Goal: Flip ONLY the lifecycle status of a Didit User entity. Use the full PATCH /v3/users/{vendor_data}/ when you also need to touch other fields.
Endpoint: PATCH https://verification.didit.me/v3/users/{vendor_data}/update-status/
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:
\- status (enum, REQUIRED) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- 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 the status actually changes. Webhooks do not carry it.
Status semantics:
\- ACTIVE → normal. New sessions allowed for this vendor_data.
\- FLAGGED → still accepted, highlighted in Console for manual review; filterable with ?status=FLAGGED.
\- BLOCKED → terminal. Adds vendor_data to the system blocklist. Subsequent session creations for the same identifier are rejected with a blocklist hit. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.
curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Chargeback fraud pattern confirmed"}'
Response 200: full updated UserDetailItem (same shape as GET /v3/users/{vendor_data}/). See /reference/data-models.
Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one STATUS_CHANGED entry to the user's comments activity log (actor = API key identity), with reason as its comment.
\- Idempotent — re-sending the same status is a no-op (no extra audit row, no extra blocklist toggle).
Failure modes:
\- 400 — validation:
\{ "status": "This field is required." }
\{ "status": "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" }
\{ "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 (or deleted). { "detail": "Not found." }
\- 429 — rate-limited.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
Colar em
## Visão geralAltera o estado de uma [entidade de utilizador](https://docs.didit.me/pt/entities/users/overview.md) entre `ACTIVE`, `FLAGGED` e `BLOCKED`. Consulte o [ciclo de vida da entidade](https://docs.didit.me/pt/entities/lifecycle.md) para ver a máquina de estados completa.## Quando utilizar- **Bloquear um utilizador** depois de confirmar fraude ou uma violação de conformidade.
- **Sinalizar um utilizador** à espera de revisão manual, sem o bloquear totalmente.
- **Desbloquear** um utilizador depois de uma remediação bem-sucedida.
- **Propagar sinais externos**, por exemplo, quando o seu próprio motor de fraude atribui a um utilizador uma pontuação acima de um limiar, altere-o para `FLAGGED` através deste endpoint.## Notas- Valores válidos: `ACTIVE`, `FLAGGED` e `BLOCKED`. Valores inválidos devolvem 400.
- Pode indicar um `reason` opcional (até 1000 caracteres) para registar o motivo da alteração de estado.
A Didit guarda-o como comentário da entrada de alteração de estado na atividade da pessoa: `comments[].comment` no utilizador e **Atividade** na Business Console.
É registado apenas quando o estado muda efetivamente.
- Os utilizadores `BLOCKED` têm todas as novas sessões recusadas automaticamente e todas as novas transações recusadas automaticamente.
- Emite um webhook `user.status.updated` com `previous_status` e `status`.
O webhook não inclui `reason`.## Aplicação| Estado | Efeito nas novas sessões | Efeito nas novas transações |
| - | - | - |
| `ACTIVE` | Fluxo normal | Fluxo normal |
| `FLAGGED` | Permitidas, mas encaminhadas para `IN_REVIEW` | Permitidas; podem ser escaladas automaticamente consoante as regras |
| `BLOCKED` | Recusadas automaticamente | Recusadas automaticamente |## 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 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 Consola determinam o que um membro da equipa pode fazer na Consola.
Não são avaliadas para pedidos feitos com chaves de API.## Relacionados- [Ciclo de vida da entidade](https://docs.didit.me/pt/entities/lifecycle.md)
- [Lista de bloqueio de utilizadores](https://docs.didit.me/pt/entities/users/blocklist.md)
- [Webhooks de entidades](https://docs.didit.me/pt/entities/webhooks.md)
## OpenAPI
````yaml pt/openapi-25.json PATCH /v3/users/{vendor_data}/update-status/
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}/update-status/:
patch:
tags:
- Users
summary: Atualizar estado do utilizador
description: >-
Altera apenas o `status` do ciclo de vida de um utilizador: `ACTIVE`,
`FLAGGED` ou `BLOCKED` (não os estados da sessão). `BLOCKED` adiciona o
`vendor_data` à lista de bloqueio do sistema; sair de `BLOCKED` remove
essa entrada. Cada alteração é registada como uma atividade
`STATUS_CHANGED` no utilizador, com o `reason` opcional como o seu
`comment`. Enviar o estado atual não altera nada e não regista nenhum
`reason`. O webhook `user.status.updated` não inclui o `reason`.
operationId: update_user_status
parameters:
- name: vendor_data
in: path
required: true
schema:
type: string
description: O seu identificador exclusivo para o utilizador.
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EntityStatusUpdateRequest'
- type: object
properties:
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:
Activate:
summary: Reativar o utilizador
value:
status: ACTIVE
Flag:
summary: Sinalizar o utilizador para revisão
value:
status: FLAGGED
Block:
summary: >-
Bloquear o utilizador (adiciona à lista de bloqueio do
sistema)
value:
status: BLOCKED
Block with reason:
summary: Bloquear o utilizador e registar o motivo
value:
status: BLOCKED
reason: Chargeback fraud pattern confirmed
responses:
'200':
description: >-
Estado do utilizador atualizado. Registo completo do utilizador
devolvido.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailItem'
examples:
Blocked:
value:
didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
vendor_data: user-abc-123
display_name: null
full_name: John Michael Doe
date_of_birth: '1990-05-15'
effective_name: John Michael Doe
status: BLOCKED
metadata:
tier: premium
source: website
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:
- uuid: c1111111-2222-4333-8444-555555555555
comment_type: STATUS_CHANGED
comment: Chargeback fraud pattern confirmed
actor_email: null
actor_name: null
previous_status: ACTIVE
new_status: BLOCKED
previous_value: null
new_value: null
changed_fields: []
metadata: null
mentioned_emails: []
created_at: '2025-06-15T10:30:00Z'
created_at: '2025-06-01T08:00:00Z'
updated_at: '2025-06-15T10:30:00Z'
'400':
description: >-
`status` em falta ou inválido, ou um `reason` com mais de 1000
carateres.
content:
application/json:
examples:
Missing status:
value:
status:
- This field is required.
Bad status:
value:
status:
- >-
Invalid status. Valid options are: ACTIVE, FLAGGED,
BLOCKED
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 (não eliminado) 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/update-status/'
\
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED"}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.update_status(
"user-123",
status="ACTIVE",
)
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.updateStatus("user-123", {
status: "ACTIVE",
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\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.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().updateStatus("user-123",
UsersUpdateStatusParams.builder()
.status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
.build());
System.out.println(result);
- lang: php
label: PHP
source: |-
users->updateStatus('user-123', [
'status' => 'ACTIVE',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.update_status(
"user-123",
status: "ACTIVE"
)
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.UpdateStatusAsync("user-123", new
UsersUpdateStatusParams
{
Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
EntityStatusUpdateRequest:
type: object
required:
- status
properties:
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
Novo estado do ciclo de vida. `BLOCKED` também adiciona o
`vendor_data` à lista de bloqueio do sistema.
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.