Skip to main content

​
POST /sub-accounts

Cria uma nova subconta completa, incluindo usuário e informações da empresa.

​
Headers

​
api_key
string
required
Chave de API do usuário
​
api_secret
string
required
Secret de API do usuário
​
Content-Type
string
required
application/json

​
Body

​
company_infos
object
required
Informações da empresa
​
company_infos.cnpj
string
required
CNPJ da empresa (formato: 12345678000195)
​
company_infos.company_name
string
required
Razão social da empresa
​
company_infos.trade_name
string
required
Nome fantasia da empresa
​
company_infos.company_type
string
required
Tipo da empresa (ex: LTDA, S.A., etc.)
​
company_infos.constitution_date
string
required
Data de constituição (formato: YYYY-MM-DD)
​
company_infos.monthly_income
number
required
Renda mensal da empresa
​
representative
object
required
Informações do representante legal
​
representative.name
string
required
Nome do representante
​
representative.email
string
required
Email do representante
​
representative.cpf
string
required
CPF do representante
​
representative.full_name
string
required
Nome completo do representante
​
representative.phone
string
required
Telefone do representante
​
representative.mother_name
string
required
Nome da mãe do representante
​
representative.monthly_income
string
required
Renda mensal do representante
​
representative.birth_date
string
required
Data de nascimento (formato: YYYY-MM-DD)
​
representative.was_signed
boolean
required
Se o representante já assinou os documentos
​
representative.signature_date
string
required
Data da assinatura (formato: YYYY-MM-DD)
​
address
object
required
Endereço da empresa
​
address.street
string
required
Rua/Logradouro
​
address.number
string
required
Número
​
address.city
string
required
Cidade
​
address.zip_code
string
required
CEP
​
address.neighborhood
string
required
Bairro
​
address.uf
string
required
UF (Estado)
​
address.adress_type
number
required
Tipo de endereço
​
ref
string
Referência opcional para identificação

​
Exemplo de Requisição

curl -X POST http://localhost:3000/sub-accounts \
  -H "api_key: ak_1234567890abcdef" \
  -H "api_secret: as_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "company_infos": {
      "cnpj": "12345678000195",
      "company_name": "Empresa Exemplo LTDA",
      "trade_name": "Empresa Exemplo",
      "company_type": "LTDA",
      "constitution_date": "2020-01-01",
      "monthly_income": 50000
    },
    "representative": {
      "name": "João Silva",
      "email": "joao@empresa.com",
      "cpf": "12345678901",
      "full_name": "João Silva Santos",
      "phone": "+5511987654321",
      "mother_name": "Maria Silva",
      "monthly_income": "3000",
      "birth_date": "1990-01-01",
      "was_signed": true,
      "signature_date": "2024-01-01"
    },
    "address": {
      "street": "Rua Exemplo",
      "number": "123",
      "city": "São Paulo",
      "zip_code": "01234567",
      "neighborhood": "Centro",
      "uf": "SP",
      "adress_type": 1
    },
    "ref": "A12as31qw78gb"
  }'

​
Resposta de Sucesso (201)

{
  "status": "success",
  "account": {
    "name": "Empresa Exemplo LTDA",
    "document": "12345678000195",
    "status": "PENDING",
    "secrets": {
      "api_key": "ak_1234567890abcdef",
      "api_secret": "as_1234567890abcdef"
    }
  }
}

​
Possíveis Erros

Dados inválidos ou campos obrigatórios não preenchidos
Api Key não encontrada ou inválida
Email já cadastrado no sistema
Erro interno do servidor durante a criação
⌘I