Detalhes da empresa | Referência da API Elix Pay

Query parameters

1 campo

user_id

integerOpcional

Identificador opcional reconhecido pelo Swagger. Omita para consultar o usuário resolvido pela credencial.

Resposta

200ReadUserDetail

Perfil detalhado do usuário autenticado e da empresa associada.

JSON · Resposta de sucesso

{  "data": {    "is_active": true,    "created_at": "2026-07-01T12:00:00Z",    "updated_at": "2026-07-01T12:00:00Z",    "id": 123,    "username": "empresa.exemplo",    "email": "integracao@empresa.com.br",    "corporate_reason": "Empresa Exemplo LTDA",    "fantasy_name": "Empresa Exemplo",    "account_number": "000123",    "cnpj": "00000000000100",    "max_limit": 0  },  "success": true,  "error": null}

{  "data": {    "is_active": true,    "created_at": "2026-07-01T12:00:00Z",    "updated_at": "2026-07-01T12:00:00Z",    "id": 123,    "username": "empresa.exemplo",    "email": "integracao@empresa.com.br",    "corporate_reason": "Empresa Exemplo LTDA",    "fantasy_name": "Empresa Exemplo",    "account_number": "000123",    "cnpj": "00000000000100",    "max_limit": 0  },  "success": true,  "error": null}

O DTO possui campos opcionais adicionais. A tabela abaixo reproduz o modelo ReadUserDetail publicado no Swagger.

Campos da resposta

57 campos

is_active

booleanObrigatório

Indica se o usuário está ativo.

created_at

string · date-timeObrigatório

Data de criação do cadastro.

updated_at

string · date-timeObrigatório

Data da última atualização.

tenant_name

stringOpcional

Nome do tenant associado.

tenant_id

integerOpcional

Identificador do tenant.

id

integerObrigatório

Identificador do usuário.

role_level

RoleLevelTypeOpcional

Nível de acesso: superuser, director, customer, partner, master, support ou analyst.

username

stringObrigatório

Nome de usuário.

email

stringObrigatório

E-mail cadastrado.

account_number

stringOpcional

Número da conta.

cpf

stringOpcional

CPF vinculado ao cadastro.

cnpj

stringOpcional

CNPJ vinculado ao cadastro.

corporate_reason

stringOpcional

Razão social da empresa.

fantasy_name

stringOpcional

Nome fantasia da empresa.

rg

stringOpcional

Documento de identidade.

birth

stringOpcional

Data de nascimento.

phone

stringOpcional

Telefone cadastrado.

max_limit

numberObrigatório

Limite máximo configurado.

country

stringOpcional

País do cadastro.

mfa_is_active

booleanOpcional

Indica se o MFA está ativo.

full_name

stringOpcional

Nome completo.

surname

stringOpcional

Sobrenome.

actual_fiat

numberOpcional

Saldo fiat atual informado pelo DTO.

total_in

numberOpcional

Total de entradas.

total_out

numberOpcional

Total de saídas.

accept_privacypolicy

stringOpcional

Registro de aceite da política de privacidade.

accept_termsuse

stringOpcional

Registro de aceite dos termos de uso.

wallets

ReadWallet[]Opcional

Carteiras associadas ao usuário.

compliance_approval

booleanOpcional

Situação da aprovação de compliance.

document_approved

booleanOpcional

Indica se os documentos foram aprovados.

first_login

booleanOpcional

Indica se é o primeiro acesso.

register_approval

booleanOpcional

Situação da aprovação do cadastro.

social

objectOpcional

Dados sociais do cadastro.

address

objectOpcional

Endereço cadastrado.

user_details

objectOpcional

Detalhes adicionais do usuário.

preferences

objectOpcional

Preferências do usuário.

company_details

objectOpcional

Detalhes da empresa.

documents

objectOpcional

Documentos associados.

mfa_details

anyOpcional

Detalhes de autenticação multifator.

fgts_pay_details

anyOpcional

Detalhes do produto FGTS Pay.

register_device_mobile

stringOpcional

Identificador do dispositivo móvel registrado.

register_device_web

stringOpcional

Identificador do dispositivo web registrado.

transfer_password

stringOpcional

Campo de senha de transferência presente no DTO.

fgts_status

stringOpcional

Status da integração FGTS.

client_id_fgts

stringOpcional

Identificador do cliente FGTS.

client_username_fgts

stringOpcional

Usuário do cliente FGTS.

client_id_user_fgts

stringOpcional

Identificador do usuário no cliente FGTS.

client_name_fgts

stringOpcional

Nome do cliente FGTS.

push_notification_id

stringOpcional

Identificador para notificações push.

mobile_device_id

stringOpcional

Identificador do dispositivo móvel.

icon_profile

stringOpcional

Ícone do perfil.

baas_status_account

stringOpcional

Status da conta no provedor BaaS.

baas_status_code

booleanOpcional

Código de estado da conta BaaS.

acquisition_account_details

AcquisitionAccountDetailsOpcional

Status e identificador da conta de adquirência.

user_credentials_keys

UserCredentialsKeysDTOOpcional

Metadados das credenciais e escopos da API.

legal_nature_cnpj

stringOpcional

Natureza jurídica do CNPJ.

partners

object[]Opcional

Sócios vinculados à empresa.

Status HTTP

200

Detalhes retornados com sucesso.

401

Credenciais ausentes, inválidas ou revogadas.

403

A credencial não possui permissão para acessar o recurso.

422

Erro de validação nos dados enviados.

429

Limite de requisições excedido.

5xx

Erro interno da plataforma.