Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve uma única entidade Utilizador identificada por vendor_data. As respostas incluem didit_internal_id: o identificador interno estável do Didit.

Quando usar

  • Consulta do estado de verificação atual de um utilizador: o mapa features apresenta o estado mais recente de cada funcionalidade num único objeto.
  • Vistas de detalhe na sua própria interface: obtenha o perfil a pedido, antes de o apresentar.
  • Pontuação de risco: combine os contadores de sessões e features para atribuir uma pontuação a cada utilizador do seu lado.

Notas

  • vendor_data no URL é sensível a maiúsculas e minúsculas.
  • Devolve 404 se não existir nenhum utilizador 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 utilizador para ver todos os campos.

Permissões

Qualquer chave de API ativa da aplicação pode chamar este endpoint. As chaves de API do Didit são limitadas à aplicação, não a funções: as funções e permissões da Console (read:users e as restantes) determinam o que uma pessoa pode fazer na Console, e não são avaliadas para o tráfego da Management API. Controle quem pode chamar este endpoint definindo quem pode ler a chave de API da aplicação.

Conteúdos relacionados

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

vendor_data
string
obrigatório

O seu identificador exclusivo para o utilizador — uma string de formato livre (NÃO um UUID). Este é o mesmo valor que indicou como vendor_data ao criar a sessão que introduziu este utilizador pela primeira vez, correspondido exatamente como enviado.

Resposta

Detalhes completos do utilizador incluindo metadados, registo de comentários/atividade e dados agregados da sessão.

Detalhe completo do utilizador. Estende UserListItem com metadados, comentários e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para este utilizador.

vendor_data
string | null

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
string | null

Nome de apresentação personalizado definido por si

full_name
string | null

Nome completo extraído de 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>

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.

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

URL pré-assinado da fotografia de retrato do utilizador (expira após algumas horas)

session_count
integer

Número total de sessões de verificação para este utilizador

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 análise

issuing_states
string[]

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

Endereços de e-mail verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, ["john@example.com"].

approved_phones
string[]

Números de telefone verificados recolhidos a partir das sessões aprovadas deste utilizador, por exemplo, ["+14155551234"].

features
object

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

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

last_session_at
string<date-time> | null

Carimbo de data/hora da sessão mais recente

first_session_at
string<date-time> | null

Carimbo de data/hora da primeira sessão

last_activity_at
string<date-time> | null

Carimbo de data/hora da atividade mais recente neste utilizador (sessão, transação, mudança de estado, edição de dados, etc.).

tags
object[]

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.

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que associou a este utilizador. O valor predefinido é {}.

comments
object[]

Registo de atividade e comentários para este utilizador (alterações de estado, edições de perfil, notas manuais).

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