Skip to main content
POST
/
api
/
v1
/
register
Register a new company
curl --request POST \
  --url http://localhost:7701/api/v1/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corp",
  "gateway_ids": [
    1,
    2
  ],
  "email": "finance@acme.com",
  "document": "12345678000195",
  "document_type": "cnpj",
  "type": "corporation",
  "bank_account": {
    "holder_name": "Acme Corp",
    "holder_type": "company",
    "holder_document": "12345678000195",
    "bank": "341",
    "branch_number": "0001",
    "account_number": "12345678",
    "account_check_digit": "9",
    "type": "checking"
  }
}
'
{
  "message": "Company registered successfully!",
  "credentials": {
    "client_id": "client_a1b2c3d4e5f6g7h8",
    "api_key": "sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "warning": "Save your api_key safely, it won't be showed again."
  }
}

Body

application/json
​
name
string
required
Example:

"Acme Corp"

​
gateway_ids
integer[] | null
Example:
[1, 2]
​
email
string<email> | null
Example:

"finance@acme.com"

​
document
string | null
Example:

"12345678000195"

​
document_type
enum<string> | null
Available options:
cpf,
cnpj
Example:

"cnpj"

​
type
enum<string> | null
Available options:
individual,
corporation
Example:

"corporation"

​
bank_account
object

Required when gateway_ids is provided

Response

Company registered successfully

​
message
string
Example:

"Company registered successfully!"

​
credentials
object