> ## 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 para listar usuários: entidades User do fornecedor > Liste todas as entidades User do fornecedor da sua aplicação Didit, filtrando por status, busca e data, e gerencie o ciclo de vida via API. Prompt para listar usuários Copiar o prompt para a área de transferência \

\`Goal: Page through Didit User entities for an application and consume them in your backend.

Endpoint: GET https://verification.didit.me/v3/users/
Auth header: x-api-key: 

Query params (all optional):
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- search: free-text over vendor_data, display_name, full_name, approved_emails, approved_phones.
\- country: ISO 3166-1 alpha-3 (e.g. "USA", "ESP") — filters by issuing country of approved documents.
\- limit: integer, 1–200, default 50.
\- offset: integer, 0+, default 0. Prefer following the "next" URL from the previous page.

curl:
curl -X GET 'https://verification.didit.me/v3/users/?limit=50&status=ACTIVE' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
\{
"count": ,
"next": ,
"previous": ,
"results": [ UserListItem, ... ]
}

UserListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, full_name, effective_name, status, portrait_image_url, session_count, approved_count, declined_count, in_review_count, issuing_states, approved_emails, approved_phones, features (map of feature -> "Approved" | "Declined" | "In Review" | ...), features_list, last_session_at, first_session_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
\- Ordered by last_session_at desc (most recently active first).
\- Deleted users are not returned.
\- vendor_data is a free-form client-supplied string, NOT a UUID. It may be null when the originating session did not provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/users/?limit=200&status=ACTIVE'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for user in page['results']:
    ...handle user...
url = page['next']

Failure modes (all return {"detail": "..."} unless noted):
\- 401 — missing or revoked x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 429 — rate-limited. Honour Retry-After header.

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

\
Colar em ## Visão geralRetorna uma lista paginada de [entidades de usuário](https://docs.didit.me/pt-br/entities/users/overview.md) da aplicação autenticada. Use este endpoint para sincronizar usuários ao seu data warehouse, encontrar usuários que precisam da atenção de um analista ou pesquisar pelo nome de exibição.## Quando usar- **Sincronização periódica** da sua tabela de usuários com uma ferramenta de BI ou um data warehouse externo. - **Filas de análise**: filtre por `status=FLAGGED` ou por `last_activity_at` desatualizado para alimentar uma caixa de entrada de revisão. - **Pesquisa** de usuários por `display_name`, `full_name` ou `vendor_data`.## Filtros e paginação| Parâmetro de consulta | Descrição | | - | - | | `status` | Filtra por `ACTIVE`, `FLAGGED` ou `BLOCKED`. | | `search` | Busca por substring em `vendor_data`, `display_name`, `full_name`, e-mails e telefones. | | `country_code` | Filtra por `issuing_states` (ISO 3166-1 alpha-3). | | `created_after`, `created_before` | Intervalo de datas de criação (ISO 8601). | | `last_activity_after`, `last_activity_before` | Intervalo de atividade. | | `page_size` | De 1 a 200. Padrão: 50. | | `cursor` | Cursor de paginação retornado na resposta anterior. |## Observações- Cada item da resposta inclui `didit_internal_id`. `vendor_data` pode ser `null` quando a sessão ou a transação original não informou esse valor. - Este endpoint pagina por cursor: guarde o cursor `next` entre as chamadas e pare quando `next` estiver vazio. - Consulte o [modelo de dados de usuário](https://docs.didit.me/pt-br/entities/users/data-model.md) para ver todos os campos de um registro de usuário.## PermissõesQualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit têm **escopo de aplicação, não de função**: as [funções e permissões](https://docs.didit.me/pt-br/console/roles-permissions.md) do Console (`list:users` e as demais) definem o que uma *pessoa* pode fazer no Console e não são avaliadas no tráfego da Management API. Para controlar quem pode chamar este endpoint, controle quem pode ler à chave de API da aplicação.## Relacionados- [Visão geral de usuários](https://docs.didit.me/pt-br/entities/users/overview.md) - [Obter usuário](https://docs.didit.me/pt-br/management-api/users/get.md) - [Operações de usuário](https://docs.didit.me/pt-br/entities/users/operations.md) ## OpenAPI ````yaml pt-br/openapi-25.json GET /v3/users/ 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/: get: tags: - Users summary: Listar usuários description: >- Lista os [usuários](/entities/users) que a Didit monta a partir de sessões KYC que compartilham o mesmo `vendor_data` (string de formato livre, NÃO um UUID), além dos usuários criados pela API. Paginado e ordenado por `last_session_at` em ordem decrescente. Este endpoint não aceita parâmetros de filtro nem de busca: busque as páginas e filtre no lado do cliente. operationId: list_users parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Tamanho da página. O padrão é 50 quando omitido. Não há máximo imposto, mas mantenha as páginas pequenas para reduzir a latência. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Deslocamento, a partir de zero, do primeiro registro a retornar. Prefira seguir a URL `next` da página anterior em vez de calcular este valor manualmente. responses: '200': description: >- Lista paginada de usuários com status de verificação, contagem de sessões e detalhamento por recurso. content: application/json: schema: type: object properties: count: type: integer description: >- Número de linhas correspondentes: exato até 100 e limitado a 100 acima disso, por desempenho. Não o use para detectar a última página; considere `next` igual a `null`. next: type: string nullable: true description: >- URL absoluta da próxima página, ou `null` na última página. previous: type: string nullable: true description: >- URL absoluta da página anterior, ou `null` na primeira página. results: type: array items: $ref: '#/components/schemas/UserListItem' examples: Example: value: count: 2 next: null previous: null results: - 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: ACTIVE 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 name: VIP color: '#2567FF' created_at: '2025-06-01T08:00:00Z' - didit_internal_id: 6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b vendor_data: null display_name: Jane S. full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' effective_name: Jane S. status: FLAGGED portrait_image_url: null session_count: 1 approved_count: 0 declined_count: 0 in_review_count: 1 issuing_states: [] approved_emails: [] approved_phones: [] features: ID_VERIFICATION: In Review features_list: - feature: ID_VERIFICATION status: In Review last_session_at: '2025-06-20T14:00:00Z' last_activity_at: '2025-06-20T14:05:00Z' first_session_at: '2025-06-20T14:00:00Z' tags: [] created_at: '2025-06-20T14:00:00Z' '401': description: >- Nenhuma credencial fornecida. Requisições para caminhos `/v3/users/*` sem um cabeçalho `x-api-key` (ou token `Authorization: Bearer`) são rejeitadas 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 listar usuários desta aplicação. Uma chave ausente retorna `403`; uma chave incorreta, revogada ou expirada retorna `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '429': description: >- Limite de requisições excedido; aguarde 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 GET 'https://verification.didit.me/v3/users/?limit=50' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.users.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.users.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.users().list()) { System.out.println(item); } - lang: php label: PHP source: |- users->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.users.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Users.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: UserListItem: type: object description: Um usuário verificado. properties: didit_internal_id: type: string format: uuid description: UUID interno estável da Didit para este usuário. vendor_data: type: string nullable: true description: >- Seu identificador exclusivo deste usuário (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado. display_name: type: string nullable: true description: Nome de exibição personalizado definido por você full_name: type: string nullable: true description: Nome completo extraído dos 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: >- 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`. portrait_image_url: type: string nullable: true description: >- URL pré-assinada da foto de retrato do usuário (expira após algumas horas) session_count: type: integer description: Número total de sessões de verificação deste usuário 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 revisão issuing_states: type: array items: type: string description: >- 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: type: array items: type: string description: >- Endereços de e-mail verificados coletados das sessões aprovadas deste usuário, por exemplo, `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Números de telefone verificados coletados das sessões aprovadas deste usuário, por exemplo, `["+14155551234"]`. features: type: object description: >- 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: type: array items: type: object properties: feature: type: string status: type: string description: >- Os mesmos dados de `features`, como um array ordenado de objetos `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Data e hora da sessão mais recente first_session_at: type: string format: date-time nullable: true description: Data e hora da primeira sessão last_activity_at: type: string format: date-time nullable: true description: >- Data e hora da atividade mais recente deste usuário (sessão, transação, mudança de status, edição de dados etc.). tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Tags atribuídas a este usuário created_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.