Skip to main content
A sub-org is a sub-account inside your PrimeVault organization. It follows the same model as a bank’s master account with sub-accounts: your organization is the master, and each sub-org holds its own vaults, contacts, bank accounts, and transactions, separate from every other sub-org.

​
When to use a sub-org

  • Onboard your customers. Create one sub-org per customer so each customer’s funds, counterparties, and activity stay separate.
  • Separate business units or entities. Give each legal entity, region, or product line its own sub-org.
  • Scope access. Manage who can see and act on each sub-org separately, while you keep one view across the whole organization.

​
How it works

  1. Create a sub-org with a name that is unique in your organization.
  2. Pass its id as subOrgId when you create vaults, contacts, and bank accounts, and when you get quotes or create transactions.
  3. List sub-orgs to find their IDs later.
Only API users with the ADMIN or OWNER role and organization-wide access can create sub-orgs. Your organization comes from authentication, so you can’t act on another organization’s sub-orgs.

​
Limits

  • The API can create and list sub-orgs. It can’t retrieve a single sub-org by ID, update one, or delete one.
  • Sub-orgs created through the API are MANAGED.

Create a Sub-Org

POST /api/external/sub_orgs/

List Sub-Orgs

GET /api/external/sub_orgs/

​
Data models

​
SubOrg

​
string (UUID)
Sub-org ID. Pass it as subOrgId on other resources.
​
string (UUID)
Parent organization.
​
string
Sub-org name. Unique within the organization.
​
SubOrgControlMode | null
MANAGED or INDEPENDENT. Some existing sub-orgs return null. Read-only. Sub-orgs created through the API are MANAGED.
​
string (date-time)
Creation timestamp.
​
string (date-time)
Last update timestamp.
​
boolean
Deletion flag. Listed sub-orgs are not deleted.

​
CreateSubOrgRequest

One required field: name: string.

​
SubOrgListResponse

A paginated list: results: SubOrg[], nextCursor: string | null, and hasNext: boolean.

​
SDK methods

​
Errors