Modelo de dados de usuário: schema do usuário do vendor

Esta página documenta todos os campos de uma entidade User. Os campos se dividem em cinco grupos: identidade, status, agregados de sessão, timestamps de atividade e metadados.

Campos de identidade

Campo	Tipo	Descrição
`uuid`	UUID	Chave primária atribuída pela Didit. Estável e única.
`didit_internal_id`	string	Identificador interno legível por humanos (exibido nas respostas da API).
`vendor_data`	string	Seu identificador para o usuário. Único por aplicação. Saiba mais.
`display_name`	string	Nome exibido no console que substitui o nome padrão. Quando não definido, usa `full_name` ou `vendor_data`.
`full_name`	string	Nome civil completo, propagado a partir do documento de identidade da sessão de Verificação de usuários (KYC) aprovada mais recente.
`date_of_birth`	data (ISO 8601)	Propagada a partir da sessão de Verificação de usuários (KYC) aprovada mais recente.
`portrait_image`	URL	URL assinada do S3 para a selfie da verificação de prova de vida aprovada mais recente.

full_name, date_of_birth e portrait_image são somente leitura quando derivados de uma sessão verificada. Você pode substituí-los pelo console ou por PATCH /v3/users/{vendor_data}/, mas as substituições manuais são sinalizadas no registro de auditoria.

Status

Campo	Tipo	Valores	Descrição
`status`	enum	`ACTIVE`, `FLAGGED`, `BLOCKED`	Controla a aplicação de restrições em sessões e transações futuras. Consulte o ciclo de vida.

Campos agregados de sessão

Esses campos são calculados pela Didit e atualizados em tempo real à medida que as sessões são concluídas.

Campo	Tipo	Descrição
`session_count`	int	Total de sessões já criadas para este usuário
`approved_count`	int	Sessões finalizadas com `APPROVED`
`declined_count`	int	Sessões finalizadas com `DECLINED`
`in_review_count`	int	Sessões atualmente em `IN_REVIEW`
`issuing_states[]`	array de códigos de país ISO	Países de todos os documentos de identidade verificados nas sessões
`approved_emails[]`	array de strings	E-mails verificados por meio da Verificação de e-mail
`approved_phones[]`	array de strings	Telefones verificados por meio da Verificação de telefone
`features`	object	Status mais recente de cada recurso em todas as sessões

O mapa `features`

Toda sessão executa um ou mais recursos (verificação de identidade, prova de vida, correspondência facial, AML, comprovante de endereço, NFC etc.). O mapa features armazena o status mais recente de cada recurso para este usuário:

{
  "id_verification": "APPROVED",
  "liveness": "APPROVED",
  "face_match": "APPROVED",
  "aml": "IN_REVIEW",
  "proof_of_address": "APPROVED",
  "nfc_verification": "NOT_FINISHED"
}

Status dos recursos: NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW, EXPIRED, ABANDONED, RESUB_REQUESTED. Use o mapa features como o caminho rápido para responder “este usuário está totalmente verificado agora?” sem percorrer todas as sessões.

Registros de data e hora da atividade

Campo	Tipo	Atualizado quando
`first_session_at`	timestamp ISO	A primeira sessão foi criada
`last_session_at`	timestamp ISO	A sessão mais recente foi criada ou atualizada
`last_activity_at`	timestamp ISO	Qualquer alteração: sessão, transação, status, perfil, notas, tags
`created_at`	timestamp ISO	A linha da entidade foi criada
`updated_at`	timestamp ISO	A linha da entidade foi atualizada pela última vez

Metadados

Campo	Tipo	Descrição
`metadata`	object (JSON)	JSON de formato livre controlado por você. Use para tags internas, nível, origem do cadastro etc.
`tags[]`	array	Tags gerenciadas pelo console ou pela API para filtrar e agrupar

Os metadados não têm esquema: a Didit persiste tudo o que você gravar.

Relações (não armazenadas no registro do usuário)

Relação	Como acessar
Sessões	`GET /v3/sessions?vendor_data=<value>`
Transações (como solicitante)	`GET /v3/transactions/?vendor_data=<value>`
Transações (como contraparte)	Filtre a lista de transações pelo vendor_data da contraparte no console
Empresas vinculadas (diretor / UBO)	Exibidas na página de detalhes do usuário no console
Biometria facial	Console + Lists API
Entradas da lista de bloqueio	Lists API: filtre as entradas pelos identificadores do usuário

Exemplo de resposta

{
  "uuid": "9c7d2a30-2f98-4d4f-9d2d-1a7c4b1e5b6a",
  "didit_internal_id": "U-2026-00042",
  "vendor_data": "user-42",
  "display_name": "Jane Doe",
  "full_name": "John Doe",
  "date_of_birth": "1990-01-01",
  "portrait_image": "https://<media-host>/...",
  "status": "ACTIVE",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": ["US", "ES"],
  "approved_emails": ["jane@example.com"],
  "approved_phones": ["+14155550123"],
  "features": {
    "id_verification": "APPROVED",
    "liveness": "APPROVED",
    "face_match": "APPROVED",
    "aml": "IN_REVIEW"
  },
  "first_session_at": "2025-03-01T12:00:00Z",
  "last_session_at": "2026-04-10T09:00:00Z",
  "last_activity_at": "2026-04-16T10:00:00Z",
  "metadata": { "tier": "premium" }
}

Próximos passos

Operações

Criar, atualizar, alterar o status, excluir.

Histórico de KYC

Recupere todas as sessões vinculadas ao usuário.

Referência da API

Esquema do GET /v3/users//.

Visão geral

Preços

Fluxos e verificação

Revisão e operações

Entidades (usuários e empresas)

Configurações e personalização

Segurança e conformidade

Didit Academy

Recursos

Modelo de dados de usuário: schema do usuário do vendor

Campos de identidade

Status

Campos agregados de sessão

O mapa `features`

Registros de data e hora da atividade

Metadados

Relações (não armazenadas no registro do usuário)

Exemplo de resposta

Próximos passos

Operações

Histórico de KYC

Referência da API

​Campos de identidade

​Status

​Campos agregados de sessão

​O mapa features

​Registros de data e hora da atividade

​Metadados

​Relações (não armazenadas no registro do usuário)

​Exemplo de resposta

​Próximos passos

Operações

Histórico de KYC

Referência da API

Campos de identidade

Status

Campos agregados de sessão

O mapa `features`

Registros de data e hora da atividade

Metadados

Relações (não armazenadas no registro do usuário)

Exemplo de resposta

Próximos passos