This quickstart guide walks you through the essential steps to setup and manage sub-accounts: creating a sub-account for your business, adding partners, and getting credentials.
Prerequisites
- You need to have a main organization account. If you don't have one, contact us at [email protected]
- Your main organization account should be verified and active
Steps
Create a sub-accountOpen account for your business.
Add a partnerAdd a partner to your account.
Get credentialsGet credentials to use in your application.
Sub-accounts are accounts that are part of a main organization account. They are used to manage the operations of a specific business unit.
API Endpoint
POST https://api.sqala.tech/core/v1/sub-accountsRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Company trade name |
| legalName | string | Yes | Company's legal name |
| taxId | string | Yes | Company taxId (Brazilian CNPJ) |
| companyType | enum | No | Company type (MEI, EMPRESARIO_INDIVIDUAL, EIRELLI, LIMITADA, SA) |
| website | string | Yes | Company's website |
| telephone | string | No | Company's phone number |
| language | string | No | Company's language locale (ISO 639-1), defaults to "en" |
| address | object | Yes | Company's address |
Address Object
| Field | Type | Required | Description |
|---|---|---|---|
| postalCode | string | Yes | Postal code |
| state | string | Yes | State |
| city | string | Yes | City |
| district | string | Yes | District |
| street | string | Yes | Street name |
| number | string | Yes | Street number |
| complement | string | No | Address complement |
Code Examples
curl -X POST https://api.sqala.tech/core/v1/sub-accounts \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"name": "Tech Solutions",
"legalName": "Tech Solutions LTDA",
"taxId": "12345678000199",
"companyType": "LTDA",
"website": "https://techsolutions.com",
"telephone": "+5511999999999",
"language": "en",
"address": {
"postalCode": "01234-567",
"state": "SP",
"city": "São Paulo",
"district": "Centro",
"street": "Avenida Paulista",
"number": "1000",
"complement": "Sala 123"
}
}'const response = await fetch('https://api.sqala.tech/core/v1/sub-accounts', {
method: 'POST',
headers: {
'Authorization': 'Bearer {token}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Tech Solutions',
legalName: 'Tech Solutions LTDA',
taxId: '12345678000199',
companyType: 'LTDA',
website: 'https://techsolutions.com',
telephone: '+5511999999999',
language: 'en',
address: {
postalCode: '01234-567',
state: 'SP',
city: 'São Paulo',
district: 'Centro',
street: 'Avenida Paulista',
number: '1000',
complement: 'Sala 123'
}
})
});
const data = await response.json();import requests
response = requests.post(
'https://api.sqala.tech/core/v1/sub-accounts',
headers={
'Authorization': 'Bearer {token}',
'Content-Type': 'application/json'
},
json={
'name': 'Tech Solutions',
'legalName': 'Tech Solutions LTDA',
'taxId': '12345678000199',
'companyType': 'LTDA',
'website': 'https://techsolutions.com',
'telephone': '+5511999999999',
'language': 'en',
'address': {
'postalCode': '01234-567',
'state': 'SP',
'city': 'São Paulo',
'district': 'Centro',
'street': 'Avenida Paulista',
'number': '1000',
'complement': 'Sala 123'
}
}
)
data = response.json()