Pular para o conteúdo principal
GET
curl

Visão geral

Retorna uma única entidade User identificada por vendor_data. As respostas incluem didit_internal_id, o identificador interno estável da Didit.

Quando usar

  • Consulta do estado de verificação atual de um usuário: o mapa features traz o status mais recente de cada recurso em um único objeto.
  • Telas de detalhes na sua própria interface: busque o perfil sob demanda antes de renderizar.
  • Pontuação de risco: combine os contadores de sessões e features para pontuar cada usuário do seu lado.

Observações

  • vendor_data na URL diferencia maiúsculas de minúsculas.
  • Retorna 404 se não existir nenhum usuário com esse vendor_data na aplicação.
  • Os contadores agregados (session_count, approved_count, declined_count, in_review_count) são atualizados em tempo real à medida que as sessões são concluídas.
  • Consulte o modelo de dados do usuário para ver todos os campos.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API da Didit são vinculadas à aplicação, não à função: as funções e permissões do Console (read: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. Controle quem pode chamar este endpoint controlando quem tem acesso à chave de API da aplicação.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

vendor_data
string
obrigatório

Seu identificador exclusivo do usuário: uma string livre (NÃO um UUID). É o mesmo valor que você passou como vendor_data ao criar a sessão que introduziu esse usuário pela primeira vez, comparado exatamente como enviado.

Resposta

Detalhes completos do usuário, incluindo metadados, comentários/registro de atividades e dados agregados das sessões.

Detalhes completos do usuário. Estende UserListItem com metadados, comentários e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para este usuário.

vendor_data
string | null

Seu identificador exclusivo deste usuário (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado.

display_name
string | null

Nome de exibição personalizado definido por você

full_name
string | null

Nome completo extraído dos documentos verificados

date_of_birth
string<date> | null
effective_name
string | null

Melhor nome disponível: display_name, se definido; caso contrário, full_name

status
enum<string>

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.

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL pré-assinada da foto de retrato do usuário (expira após algumas horas)

session_count
integer

Número total de sessões de verificação deste usuário

approved_count
integer

Número de sessões aprovadas

declined_count
integer

Número de sessões recusadas

in_review_count
integer

Número de sessões em revisão

issuing_states
string[]

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
string[]

Endereços de e-mail verificados coletados das sessões aprovadas deste usuário, por exemplo, ["john@example.com"].

approved_phones
string[]

Números de telefone verificados coletados das sessões aprovadas deste usuário, por exemplo, ["+14155551234"].

features
object

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
object[]

Os mesmos dados de features, como um array ordenado de objetos {feature, status}.

last_session_at
string<date-time> | null

Data e hora da sessão mais recente

first_session_at
string<date-time> | null

Data e hora da primeira sessão

last_activity_at
string<date-time> | null

Data e hora da atividade mais recente deste usuário (sessão, transação, mudança de status, edição de dados etc.).

tags
object[]

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.

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que você anexou a este usuário. O padrão é {}.

comments
object[]

Registro de atividades e comentários deste usuário (alterações de status, edições de perfil, notas manuais).

updated_at
string<date-time>
Última modificação em 1 de novembro de 2026