Create a Sub-Account
Create a sub-account for your Atlas platform integration, validate required fields like subCategory against supported industry classifications, and prepare the customer for onboarding and scoped operations.
Create a Sub-Account
Create a sub-account to establish the customer context that will own wallets, compliance records, receive accounts, and payout activity in your Atlas platform integration.
Developer ContextCreating a sub-account only requires basic entity metadata. Once created, the account enters a
PENDINGstate until compliance verification is completed.
✅ Before you create the sub-account
Complete these steps first:
- Authenticate with your master platform credentials.
- Confirm you are building an Atlas platform flow, not a direct own-funds flow.
- Gather the legal entity name, jurisdiction, industry category, and registry or identification number for the customer.
- Decide where you will store the returned sub-account ID because you will need it for all later scoped operations.
- Validate
subCategoryagainst the Supported Industry Classifications page before you send the request.
🚀 API Implementation
Provision a new sub-account by providing the business identity and jurisdiction.
curl -X POST https://api.sandbox.vertofx.com/v2/sub-accounts \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Logistical LLC",
"country": "United Kingdom",
"subCategory": "Advertising & marketing company",
"identificationNumber": "UK12345678",
"accountType": "sub_client"
}'subCategory must exactly match one of the supported values on the Supported Industry Classifications page.
When this request succeeds, store the returned sub-account ID and treat it as the parent key for wallets, accounts, statements, beneficiaries, and payouts that belong to that customer.
📋 Required Schema
To ensure a smooth transition to verified status, validate the following fields before submission:
| Field | Requirement | Logic |
|---|---|---|
name | Mandatory | Legal business name (Max 50 chars). |
country | Mandatory | Full country name or ISO code. |
subCategory | Mandatory | Must exactly match a value from Supported Industry Classifications. |
identificationNumber | Mandatory | Official registry number (e.g., Companies House, CAC). |
accountType | Static | Always set to sub_client. |
Validate these fields before submission so the customer can move through compliance review without avoidable delays.
🏛️ Contextual Awareness
The "Identity" Header Upon successful creation, the API returns a
sub_acc_id(e.g.,sub_acc_778899). Save this ID. You will need it in theX-Sub-Account-Idheader for every subsequent wallet or payout operation performed for this user.
What happens next
After creation, the sub-account is not ready to transact immediately:
- Submit the required KYB or KYC data for review.
- Wait until the sub-account reaches an operationally approved state.
- Create wallets only after the customer can transact.
- Issue accounts, receive funds, or send payouts from that sub-account context as needed.
Troubleshooting
| Issue | What to check |
|---|---|
| Creation request fails | Confirm all required entity fields are present and formatted correctly for the target jurisdiction. |
| Invalid company sub-category / 400 error | Check that subCategory exactly matches a value from Supported Industry Classifications, including spelling, capitalization, and punctuation. |
| Sub-account stays pending | Verify the required onboarding and compliance data has been submitted. |
| Later actions affect the wrong customer | Confirm your system stored and reused the correct sub_acc_id in the X-Sub-Account-Id header. |
🎯 Next Steps
| Add KYB Details → Submit the compliance data required for approval. | Wallets → Create the first ledger after the sub-account is approved. |
Updated about 1 month ago
