1. Conta (Dados do Seller)
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
          GET
      • Cobranças PIX
        • Criar cobrança PIX
        • Listar cobranças
        • Consultar cobrança por correlationID
        • Histórico de webhooks de uma cobrança
      • Cartão (Checkout Transparente)
        • Criar pagamento com cartão (PAN via API)
      • Saldo
        • Consultar saldo
      • Saques e Chaves PIX
        • Listar chaves PIX cadastradas
        • Cadastrar chave PIX
        • Listar saques
        • Solicitar saque
        • Cancelar saque pendente
      • Clientes
        • Listar clientes
        • Detalhe de um cliente
      • Produtos e Links de Pagamento
        • Links de compra por comprador (Purchase Links)
          • Criar link de compra (por comprador)
          • Listar links de compra do produto
          • Detalhe/status do link de compra
          • Revogar link de compra
        • Listar produtos
        • Criar produto
        • Detalhe do produto
        • Carrinhos abandonados do produto
      • Splits
        • Analytics de splits enviados
        • Splits recebidos
      • Disputas e MEDs
        • Listar disputas
        • Listar MEDs com estatísticas
        • Evidências de uma disputa
        • Histórico de uma disputa
      • Subcontas White-Label (BaaS)
        • Criar subconta
        • Listar subcontas
        • Detalhe da subconta
        • Atualizar subconta
        • Excluir subconta (soft delete)
        • Enviar KYC da subconta (multipart)
        • Consultar status do KYC da subconta
        • Cadastrar chave PIX da subconta
        • Listar chaves PIX da subconta
        • Remover chave PIX da subconta
        • Criar cobrança da subconta
        • Listar cobranças da subconta
        • Detalhe de cobrança da subconta
        • Saldo da subconta
        • Extrato (transações) da subconta
        • Solicitar saque da subconta
        • Listar saques da subconta
        • Atualizar taxas da subconta
      • Webhooks (Gerenciar Endpoints)
        • Listar endpoints
        • Criar endpoint
        • Atualizar endpoint
        • Remover endpoint
      • Webhooks (Eventos Recebidos)
        • EVENT:CHARGE_CREATED — cobrança criada
        • EVENT:CHARGE_PAID — cobrança paga (atualização principal)
        • EVENT:CHARGE_EXPIRED — cobrança expirada
        • EVENT:SPLIT_RECEIVED — você recebeu um split
        • EVENT:DISPUTE_OPENED — MED/disputa aberta
        • EVENT:DISPUTE_WON — disputa ganha
        • EVENT:DISPUTE_LOST — disputa perdida
        • EVENT:DISPUTE_CANCELED — disputa cancelada
        • EVENT:WITHDRAWAL_COMPLETED — saque concluído
        • EVENT:WITHDRAWAL_FAILED — saque falhou
        • EVENT:SUBACCOUNT_KYC_APPROVED — KYC da subconta aprovado
        • EVENT:SUBACCOUNT_KYC_REJECTED — KYC da subconta recusado
        • EVENT:SUBACCOUNT_PIX_KEY_APPROVED — chave PIX da subconta aprovada
        • EVENT:SUBACCOUNT_PIX_KEY_REJECTED — chave PIX da subconta recusada
      • Notificações
        • Listar notificações
      • Dashboard / Analytics
        • Stats gerais
        • Atividade recente
        • Atividade (timeline)
        • Receita por período
        • Volume por período
        • Taxa de conversão
        • Métodos de pagamento
        • Transações (gráfico)
        • Analytics avançado
  1. Conta (Dados do Seller)

Identificar a conta (dados do seller)

GET
/api/auth/me

Autenticação#

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:
Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Identificar a conta#

Escopo necessário: nenhum (sempre permitido para chaves válidas).
Retorna os dados do seller dono da API Key usada na requisição. Use este endpoint:
Como healthcheck da sua integração (200 = chave válida, 401 = inválida/revogada/expirada).
Para descobrir o id, email, taxId (CPF/CNPJ), companyId e o adquirente (acquirer) atribuído à sua conta — informação útil para construir UIs de "painel do seller" sem hardcodar.

Resposta#

authenticated (bool) — sempre true em sucesso.
authMethod (string) — "api-key" quando autenticado via Bearer (este caso).
user (object) — id, email, name, role, avatarUrl, taxId, taxIdType (CPF|CNPJ), companyId, acquirer (WOOVI|TREEAL|ASAAS|SIMPAY), onboardingStatus, disabledFeatures.
impersonation.isImpersonating (bool) — sempre false para autenticação via API Key.
Quer dados completos da empresa (razão social, endereço, dados do representante)? Hoje o endpoint retorna taxId e companyId — os campos completos de empresa estão disponíveis no dashboard. Se precisar dos dados completos via API, abra um ticket de suporte: estamos avaliando expor GET /api/seller agregado em uma próxima versão.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header

Respostas

🟢200
application/json
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/auth/me' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso (200) — chave válida (vk_test_/vk_live_)
{
  "authenticated": true,
  "authMethod": "api-key",
  "user": {
    "id": "clxxx0001",
    "email": "contato@suaempresa.com.br",
    "name": "Sua Empresa LTDA",
    "role": "USER",
    "avatarUrl": null,
    "acquirer": "TREEAL",
    "disabledFeatures": [],
    "taxId": "12345678000190",
    "onboardingStatus": "COMPLETED",
    "companyId": "clcompany0001"
  },
  "impersonation": { "isImpersonating": false }
}
Modificado em 2026-07-02 06:57:27
Página anterior
Conta (Dados do Seller)
Próxima página
Cobranças PIX
Built with