> ## 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 criar usuário: entidade User do fornecedor > Pré-cadastre usuários na Didit antes das sessões de KYC. Importe em massa de bases externas ou registre usuários para monitoramento de transações. Prompt para criar usuário Copiar o prompt para a área de transferência \

\`Goal: Pre-create a Didit User entity by vendor_data before any verification session runs, and optionally email the person a verification link in the same call.

Endpoint: POST https://verification.didit.me/v3/users/create/
Auth header: x-api-key: 
Content-Type: application/json

Request body fields:
\- vendor_data (string, REQUIRED) — your unique identifier for this user. Free-form string, NOT a UUID. Must be unique among non-deleted users in the app. Normalised lowercase + whitespace trim, so "USER-1" and "user-1" collide. Max 2000 bytes (UTF-8 encoded); longer values return a 400.
\- full_name (string, max 512, optional)
\- display_name (string, optional) — friendly label for the Console (takes precedence over full_name for UI).
\- date_of_birth (string YYYY-MM-DD, optional)
\- status (enum, optional) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Defaults to "ACTIVE".
\- metadata (object, optional) — arbitrary JSON you attach to the user.
\- approved_emails (object, optional) — e.g. {"john@example.com": true}.
\- approved_phones (object, optional).
\- issuing_states (object, optional) — e.g. {"USA": 1}.

Contact fields (all optional):
\- first_name, last_name (string, max 255 each): joined with a space into full_name when you don't send full_name.
\- email (string, email): stored in metadata.contact.email.
\- phone_number (string, max 32): stored in metadata.contact.phone_number.
\- country (string): ISO 3166 code, alpha-2 or alpha-3 ("ES" or "ESP"), stored uppercased in metadata.address.country.

Verification link (optional):
\- send_verification_link (boolean, default false): when true, Didit also creates a verification session for the person on workflow_id and emails them the link at email.
\- workflow_id (UUID): REQUIRED with send_verification_link. The workflow must verify a person: a Business Verification (KYB) workflow is refused.
\- language (string, max 10): language of the verification email, a supported language code. English when omitted.
\- The person and the session are created together or not at all. The session runs the same checks as POST /v3/session/ (blocklist, credits).

curl:
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'

curl with a verification link:
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "YOUR_WORKFLOW_ID"}'

Response 201: full UserDetailItem (same shape as GET /v3/users/{vendor_data}/) plus verification_link. Includes didit_internal_id (UUID), session_count, approved_count=0, metadata, comments=[], created_at, updated_at. See /reference/data-models.
\- verification_link is always present: null without a link, otherwise { session_id, session_number, status, url, workflow_id, email }. url is the link Didit emailed.

Failure modes:
\- 400: nothing is written. Most errors are keyed by field. Common cases:
\{ "vendor_data": ["A user with this vendor_data already exists."] }  // conflict, NOT idempotent. Use PATCH /v3/users/{vendor_data}/ to update.
\{ "vendor_data": ["This field is required."] }
\{ "vendor_data": ["Ensure this field has no more than 2000 characters."] }  // oversized vendor_data, rejected before it reaches storage
\{ "metadata": ["Metadata must be a JSON object."] }
\{ "country": ["Use an ISO 3166 country code, like ES or ESP."] }
\{ "email": ["metadata.contact must be a JSON object to store this value."] }  // same on phone_number; metadata.address on country
\{ "email": ["An email address is required to send a verification link."] }
\{ "workflow_id": ["Pick the workflow to send a verification link for."] }
\{ "workflow_id": ["Invalid workflow_id."] }
\{ "workflow_id": ["This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link."] }
\{ "contact_details": { "email_lang": ["Invalid email language. Supported languages are ..."] } }  // unsupported language
\{ "vendor_data": "This user or business has been blocked and cannot create new verification sessions." }
\{ "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" }
\- 401: missing or 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 key without users write. { "detail": "This API key has no write access to people." }
\- 403: send_verification_link with a scoped key that lacks sessions write. Nothing is written. { "detail": "This API key has no write access to sessions." }
\- 429: rate-limited.

Upsert pattern (this endpoint is NOT idempotent):
GET /v3/users/{vendor_data}/  → on 404, POST /v3/users/create/; on 200, PATCH /v3/users/{vendor_data}/.

Notes:
\- Verified-session-derived identity fields such as full_name and date_of_birth seeded here can be overwritten by the first approved User Verification (KYC) session.
\- If you are migrating from another provider and already have a trusted face image, create the User first, read didit_internal_id from this response, then call POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/.
\- The create itself sends no webhook. Later changes to the user send user.data.updated or user.status.updated. With send_verification_link, the new session updates the user (session_count) in the same call, which sends user.data.updated.
\- API key access: a scoped key needs users write; with send_verification_link it also needs sessions write. Full-access keys can always call it.

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

\
Colar em ## Visão geralCria explicitamente uma [entidade de usuário](https://docs.didit.me/pt-br/entities/users/overview.md) antes de qualquer sessão ser executada. A entidade retornada fica com o status `ACTIVE`, a menos que você especifique outro. Opcionalmente, a mesma chamada envia à pessoa, por e-mail, um link de verificação (consulte [Enviar um link de verificação](#enviar-um-link-de-verificação)).## Quando usar- **Pré-carregar metadados** (nível, origem do cadastro, tags internas) antes de o cliente se verificar. - **Migrar de outro fornecedor**: recrie sua base de usuários existente na Didit para que o histórico e as análises partam de uma base conhecida. - **Importar rostos de perfil confiáveis**: crie primeiro o usuário e depois chame [Enviar rosto do usuário](https://docs.didit.me/pt-br/management-api/users/upload-face.md) com o `didit_internal_id` retornado. - **Casos de uso apenas com transações**: registre um usuário com `vendor_data` para enviar transações sem nunca executar uma sessão de Verificação de Usuário (KYC). - **Convidar alguém para realizar a verificação**: crie a pessoa e envie a ela um link de verificação por e-mail em uma única chamada.## Dados de contatoVocê pode enviar os dados de contato da pessoa junto com os campos do perfil. `first_name` e `last_name` são unidos com um espaço em `full_name` quando você não envia `full_name`. `email` e `phone_number` são armazenados em `metadata.contact`, e `country` em `metadata.address`. `country` aceita um código ISO 3166, alfa-2 ou alfa-3 (`ES` ou `ESP`), e é armazenado em maiúsculas.Se o `metadata` que você enviar já tiver um valor para `contact` ou `address` que não seja um objeto JSON, a Didit não o sobrescreve: a chamada retorna `400` para o campo de contato que precisava dele.## Enviar um link de verificaçãoDefina `send_verification_link` como `true` para convidar a pessoa a realizar a verificação na mesma requisição. A Didit cria uma sessão de verificação para a pessoa no fluxo de verificação (workflow) indicado em `workflow_id` e envia o link por e-mail para `email`. Use `language` para escolher o [idioma](https://docs.didit.me/pt-br/integration/supported-languages.md) do e-mail; se você o omitir, o e-mail será em inglês.```bash theme={null} curl -X POST https://verification.didit.me/v3/users/create/ \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "YOUR_WORKFLOW_ID", "language": "es" }' ```- `email` e `workflow_id` são obrigatórios ao enviar um link, e o fluxo precisa verificar uma pessoa: um fluxo de Verificação de empresas (KYB) retorna `400`. - A sessão passa pelas mesmas verificações de [Criar sessão](https://docs.didit.me/pt-br/sessions-api/create-session.md). Um `vendor_data` na lista de bloqueio ou créditos insuficientes resultam em `400`. - A pessoa e a sessão são criadas juntas ou não são criadas. Quando qualquer verificação falha, nada é gravado e nenhum e-mail é enviado. - A resposta traz `verification_link` com `session_id`, `session_number`, `status`, `url` e `workflow_id` da sessão, além do `email` para o qual o link foi enviado. Sem link, `verification_link` é `null`.## Observações- `vendor_data` é obrigatório e deve ser único por aplicação. Tentar criar um duplicado retorna um erro de conflito: use [`PATCH /v3/users/{vendor_data}/`](https://docs.didit.me/pt-br/management-api/users/update) para atualizar um usuário existente. - `vendor_data` tem um limite rígido de 2000 bytes (codificado em UTF-8). Um valor acima desse limite retorna um erro de validação 400 em vez de ser aceito. - Campos que normalmente são derivados de sessões verificadas (`full_name`, `date_of_birth`) podem ser preenchidos previamente aqui, mas podem ser **sobrescritos** pela primeira sessão de Verificação de usuário (KYC) aprovada. - Este endpoint não aceita imagens de rosto. Para anexar um rosto importado confiável, use [`POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/`](https://docs.didit.me/pt-br/management-api/users/upload-face) depois que este endpoint retornar `didit_internal_id`. - A criação em si não envia nenhum webhook. Alterações posteriores no usuário enviam `user.data.updated` ou `user.status.updated`. - Com `send_verification_link`, a nova sessão atualiza o usuário na mesma requisição, o que envia `user.data.updated`.## PermissõesO segredo principal e as [chaves de API](https://docs.didit.me/pt-br/console/api-keys.md) com acesso total sempre podem chamar este endpoint. Uma chave com acesso personalizado precisa de permissão de escrita em **Pessoas** (`users`). Com `send_verification_link: true`, ela também precisa de permissão de escrita em **Sessões**, porque a chamada cria uma sessão e entrega o link dela. Sem essa permissão, a chamada responde `403` com `This API key has no write access to sessions.` e nada é gravado. Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue acessar este endpoint.As [funções e permissões](https://docs.didit.me/pt-br/console/roles-permissions.md) do Console definem 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- [Modelo de dados do usuário](https://docs.didit.me/pt-br/entities/users/data-model.md) - [Enviar rosto do usuário](https://docs.didit.me/pt-br/management-api/users/upload-face.md) - [Vinculação de dados do fornecedor](https://docs.didit.me/pt-br/entities/vendor-data-linking.md) - [Operações do usuário](https://docs.didit.me/pt-br/entities/users/operations.md) ## OpenAPI ````yaml pt-br/openapi-25.json POST /v3/users/create/ 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/create/: post: tags: - Users summary: Criar usuário description: >- Cria um [usuário](/entities/users) por `vendor_data`, antes de uma sessão de verificação ou sem ela. `vendor_data` deve ser único entre os usuários da aplicação (um valor duplicado retorna `400`). Não é idempotente. **Dados de contato:** `email` e `phone_number` são armazenados em `metadata.contact`, e `country` em `metadata.address`. Quando você envia `first_name` ou `last_name` sem `full_name`, a Didit os une em `full_name`. **Link de verificação:** com `send_verification_link: true`, a Didit também cria uma sessão de verificação para a pessoa no `workflow_id` e envia o link por e-mail para `email`. A sessão executa as mesmas verificações de [Criar sessão](/pt-br/sessions-api/create-session), como a lista de bloqueio e o seu saldo de créditos. A pessoa e a sessão são criadas juntas ou não são criadas: se qualquer verificação falhar, nada é gravado e nenhum e-mail é enviado. O `verification_link` da resposta descreve a sessão e é `null` quando você não solicita um link. **Acesso por chave de API:** uma chave de API com escopo precisa de permissão de escrita em `users`. Com `send_verification_link: true`, ela também precisa de permissão de escrita em `sessions`, ou a chamada responde `403` antes de qualquer gravação. Chaves com acesso total não são afetadas. Consulte [Chaves de API](/pt-br/console/api-keys). operationId: create_user requestBody: required: true content: application/json: schema: type: object required: - vendor_data properties: vendor_data: type: string description: >- Seu identificador exclusivo deste usuário (string livre, NÃO um UUID). Deve ser único entre os usuários da aplicação; comparado exatamente como enviado. full_name: type: string nullable: true maxLength: 512 description: Nome legal completo do usuário. display_name: type: string nullable: true description: >- Nome de exibição amigável mostrado no console (tem prioridade sobre `full_name` na exibição da interface). maxLength: 255 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 default: ACTIVE description: Status inicial do ciclo de vida. O padrão é `ACTIVE`. metadata: type: object nullable: true description: >- Objeto JSON arbitrário que você anexa ao usuário. O padrão é `{}`. approved_emails: type: array items: type: string description: >- Endereços de e-mail pré-confiáveis deste usuário, por exemplo `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Números de telefone pré-confiáveis deste usuário, por exemplo `["+14155551234"]`. issuing_states: type: array items: type: string description: >- Países emissores pré-registrados (ISO 3166-1 alpha-3), por exemplo `["USA"]`. first_name: type: string maxLength: 255 description: >- Nome próprio. Quando `full_name` não é enviado, a Didit junta `first_name` e `last_name` com um espaço em `full_name`. Não é retornado como um campo separado. last_name: type: string maxLength: 255 description: >- Sobrenome. Combinado com `first_name` em `full_name` quando `full_name` não é enviado. Não é retornado como campo separado. email: type: string format: email description: >- E-mail de contato, armazenado em `metadata.contact.email` (substitui um `email` que você envie dentro de `metadata.contact`). Obrigatório quando `send_verification_link` é `true`: o link é enviado para este endereço. Se `metadata.contact` não for um objeto JSON, a chamada responde `400` neste campo. phone_number: type: string maxLength: 32 description: >- Número de telefone de contato, armazenado em `metadata.contact.phone_number`. Se `metadata.contact` não for um objeto JSON, a chamada responde `400` neste campo. country: type: string maxLength: 3 description: >- País como código ISO 3166, alpha-2 ou alpha-3 (`ES` ou `ESP`). Armazenado em maiúsculas em `metadata.address.country`. Se `metadata.address` não for um objeto JSON, a chamada responde `400` neste campo. send_verification_link: type: boolean default: false description: >- Quando `true`, a Didit cria uma sessão de verificação para a pessoa no `workflow_id` e envia o link por e-mail para `email`. Exige `email` e `workflow_id`. Uma chave de API com escopo também precisa de permissão de escrita em `sessions`. workflow_id: type: string format: uuid description: >- O fluxo da sessão de verificação. Obrigatório quando `send_verification_link` é `true`. Ele deve verificar uma pessoa: um fluxo de Verificação de empresas (KYB) é recusado. Ignorado caso contrário. language: type: string maxLength: 10 description: >- Idioma do e-mail de verificação, como um código de [idioma suportado](/pt-br/integration/supported-languages). Inglês quando omitido. Ignorado quando `send_verification_link` não é `true`. examples: Basic: summary: Criar com informações básicas value: vendor_data: user-abc-123 full_name: John Doe Full: summary: Todos os campos value: vendor_data: user-abc-456 full_name: Jane Smith display_name: Jane S. date_of_birth: '1990-05-15' status: ACTIVE metadata: tier: premium source: api approved_emails: - jane@example.com Contact details: summary: Nome, e-mail, telefone e país value: vendor_data: user-abc-789 first_name: Julia last_name: Martin email: julia.martin@example.com phone_number: '+34600000000' country: ES With verification link: summary: >- Criar a pessoa e enviar a ela um link de verificação por e-mail value: vendor_data: user-abc-789 first_name: Julia last_name: Martin email: julia.martin@example.com send_verification_link: true workflow_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 language: es responses: '201': description: >- Usuário criado. O registro completo do usuário (mesmo formato de Get User), mais `verification_link`: a sessão de verificação que a Didit enviou por e-mail quando `send_verification_link` era `true`; caso contrário, `null`. content: application/json: schema: allOf: - $ref: '#/components/schemas/UserDetailItem' - type: object required: - verification_link properties: verification_link: type: object nullable: true description: >- A sessão de verificação que a Didit criou e enviou por e-mail à pessoa. Sempre presente: `null` quando `send_verification_link` não era `true`. required: - session_id - session_number - status - url - workflow_id - email properties: session_id: type: string format: uuid description: ID da sessão de verificação. session_number: type: integer description: >- Número sequencial da sessão dentro da sua aplicação. status: type: string description: >- Status da sessão; `Not Started` para uma sessão que acabou de ser criada. url: type: string format: uri description: >- O link de verificação que a Didit enviou por e-mail à pessoa. workflow_id: type: string format: uuid nullable: true description: O fluxo que a sessão executa. email: type: string format: email description: O endereço para o qual o link foi enviado. examples: Created: value: didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: null full_name: John Doe date_of_birth: null effective_name: John Doe status: ACTIVE metadata: {} portrait_image_url: null session_count: 0 approved_count: 0 declined_count: 0 in_review_count: 0 issuing_states: [] approved_emails: [] approved_phones: [] features: {} features_list: [] last_session_at: null last_activity_at: '2025-06-15T10:30:00Z' first_session_at: null tags: [] comments: [] created_at: '2025-06-15T10:30:00Z' updated_at: '2025-06-15T10:30:00Z' verification_link: null Created with verification link: value: didit_internal_id: 9b2f6c1e-3d4a-4e5f-8a7b-1c2d3e4f5a6b vendor_data: user-abc-789 display_name: null full_name: Julia Martin date_of_birth: null effective_name: Julia Martin status: ACTIVE metadata: contact: email: julia.martin@example.com portrait_image_url: null session_count: 1 approved_count: 0 declined_count: 0 in_review_count: 0 issuing_states: [] approved_emails: [] approved_phones: [] features: {} features_list: [] last_session_at: '2025-06-15T10:30:00Z' last_activity_at: '2025-06-15T10:30:00Z' first_session_at: '2025-06-15T10:30:00Z' tags: [] comments: [] created_at: '2025-06-15T10:30:00Z' updated_at: '2025-06-15T10:30:00Z' verification_link: session_id: 3fa85f64-5717-4562-b3fc-2c963f66afa7 session_number: 43762 status: Not Started url: https://verify.didit.me/en/session/3FaJ9wLqX2Mz workflow_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 email: julia.martin@example.com '400': description: >- Corpo inválido, indexado por campo: normalmente um `vendor_data` duplicado, um campo obrigatório ausente ou um valor malformado. Com `send_verification_link: true`, também um `email` ou `workflow_id` ausente, um fluxo desconhecido ou de Verificação de empresas (KYB), um `language` não suportado (indexado como `contact_details.email_lang`), um `vendor_data` na lista de bloqueio ou créditos insuficientes para iniciar a sessão. Nada é gravado. content: application/json: examples: Duplicate: value: vendor_data: - A user with this vendor_data already exists. Missing vendor_data: value: vendor_data: - This field is required. Bad metadata: value: metadata: - Metadata must be a JSON object. Bad status: value: status: - >- Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED Bad country: value: country: - Use an ISO 3166 country code, like ES or ESP. Contact not an object: value: email: - >- metadata.contact must be a JSON object to store this value. Address not an object: value: country: - >- metadata.address must be a JSON object to store this value. Link without email or workflow: value: email: - >- An email address is required to send a verification link. workflow_id: - Pick the workflow to send a verification link for. Unknown workflow: value: workflow_id: - Invalid workflow_id. Business workflow: value: workflow_id: - >- This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link. Blocklisted vendor_data: value: vendor_data: >- This user or business has been blocked and cannot create new verification sessions. Insufficient credits: value: detail: >- You don't have enough credits to perform this request. Please top up at https://business.didit.me '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: >- Chave de API inválida ou revogada, ou a chave não pode criar usuários para esta aplicação. Uma chave de API com escopo precisa de permissão de escrita em `users`, e também de escrita em `sessions` quando `send_verification_link` é `true`; nada é gravado. 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. No sessions write: summary: >- Chave com escopo solicita um link de verificação sem sessions write value: detail: This API key has no write access to sessions. '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 POST 'https://verification.didit.me/v3/users/create/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.create( vendor_data="user-abc-123", full_name="John Doe", ) 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.create({ vendor_data: "user-abc-123", full_name: "John Doe", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Create(ctx, didit.UsersCreateParams{\n\tVendorData: \"user-abc-123\",\n\tFullName: didit.String(\"John Doe\"),\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.UsersCreateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().create(UsersCreateParams.builder() .vendorData("user-abc-123") .fullName("John Doe") .build()); System.out.println(result); - lang: php label: PHP source: |- users->create([ 'vendor_data' => 'user-abc-123', 'full_name' => 'John Doe', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.create( vendor_data: "user-abc-123", full_name: "John Doe" ) 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.CreateAsync(new UsersCreateParams { VendorData = "user-abc-123", FullName = "John Doe", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: UserDetailItem: type: object description: >- Detalhes completos do usuário. 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 você anexou a este usuário. O padrão é `{}`. tags: type: array description: >- 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. items: type: object properties: uuid: type: string format: uuid description: UUID da atribuição da tag (não da tag 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: >- Registro de atividades e comentários deste usuário (alterações de status, edições de perfil, notas manuais). updated_at: type: string format: date-time 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.