Skip to main content
GET
Visualizar usuário

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Path Parameters

user_hash
string
required

Hash do usuário

Response

Dados do usuário retornados com sucesso

code
string
required

Código único do usuário

status
string
required

Status do usuário

name
string
required

Nome do usuário

email
string
required

Email do usuário

type
enum<string>
required

Tipo do usuário

Available options:
person,
company
is_approved
boolean
required

Se o usuário foi aprovado

is_registration_completed
boolean
required

Se o registro foi completado

created_at
string<date-time>
required

Data e hora no formato ISO 8601

public_token
string

Token público para autenticação em endpoints protegidos

cpf
string

CPF do usuário (apenas para pessoa física)

cnpj
string

CNPJ do usuário (apenas para pessoa jurídica)

legacy
boolean

Indica se o usuário é legado para o client autenticado. Usuários legados foram criados antes da integração com o Nexus (origem diferente de nexus) e não podem ter o perfil atualizado pela API. Presente apenas quando há um client autenticado.