Subaccounts

Subaccounts are children of a platform account, and can be used to isolate resources and configuration settings. For a more detailed explanation, check out the Platforms and Subaccounts section.

List subaccounts

Retrieve a paginated list of all subaccounts that belong to your platform account. See Pagination.

SecurityApiKey
Request
query Parameters
order
string

Order listing results in ascending or descending order, when using order_by.
Accepted values are asc or desc. If not passed, defaults to ascending asc.

Examples:
order=desc
order_by
string

Order listing results by a specific property.

Examples:
order_by=created_at
page
integer

The page number to retrieve.

per_page
integer

The maximum number of results per page.

query
string

Filter listing results by a specific property.

Examples:
query[created_at_gteq]=2022-01-01T00:00:00.000Z
Responses
200

List of subaccounts

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/sub_accounts
Request samples 
Response samples 
application/json
{
  • "object": "list",
  • "meta": {
    },
  • "data": [
    ]
}
Create a subaccount
From your platform account, create a subaccount. 
 You'll need to provide at least one permissible purpose. You may also provide the account_packages information from your platform account. For a more detailed explanation, check out the Platforms and Subaccounts section.

 Upon creating a new subaccount you will get a 201 Created response.
 If you send another POST with the same account_name it will refresh the API token and return 200 OK with the existing account details.
 To make any further updates to the new subaccount, use the new API key from that account and call the PATCH Accounts route.


SecurityApiKey 
Request 
Request Body schema: 
account_name
required
string
Name of the subaccount.


 
Array of objects
The account packages that will be created for the subaccount. If this field and the permissible_purpose_ids are provided together, the permissible purpose from the account packages provided should be included in the permissible_purpose_ids.


 
actions_email_address
string
Actions email address of the subaccount.


 
additional_company_info
string
Any extra information that you want to provide.


 
required
object
 
billing_contact_first_name
string
The first name of the billing contact.


 
billing_contact_last_name
string
The last name of the billing contact.


 
billing_email
string
The email of the billing contact.


 
company_phone_number
string
This is for our business verification purposes and will not be included on candidate communication. Must be E.164 format, e.g. +14155552671.


 
compliance_email_address
string
Compliance email address of the subaccount.


 
create_api_key
boolean
If false, an API key will not be created.  This value defaults to true.


 
ein
string
 
email_address
required
string
Email address of the subaccount owner. This person will be responsible for signing the subaccount's legal documents during credentialing.

 See the Credentialing Subaccounts section.


 
first_name
required
string
First name of the subaccount owner.


 
last_name
required
string
Last name of the subaccount owner.


 
legal_business_name
string
The account legal business name.


 
legal_entity_type
string
The type of the legal entity, valid options: b-corporation, corporation, c-corporation, limited-liability-partnership, limited-liability-corporation, limited-partnership and non-profit.


 
owner_title
string
The title of the owner of the account.


 
permissible_purpose_id
string <UUID> 
The unique identifier for the subaccount permissible purpose. This field is not required when the account packages or permissible_purpose_ids are provided.


 
permissible_purpose_ids
Array of strings <UUID> 
The unique identifiers for the subaccount permissible purposes. If this field and the account packages are provided they should match the account packages permissible purposes.


 
state_of_incorporation
string
 
support_email_address
string
Support email address of the subaccount.


 
support_phone
string
Support phone number of the subaccount. Must be E.164 format, e.g. +14155552671.


 
tech_email_address
string
Tech email address of the subaccount.


 
url
string
Relevant URL for subaccount.


 
Responses 
200
Account already exists


201
Created


400
Bad Request


401
Unauthorized


404
Not Found


422
Unprocessable Entity


post/sub_accounts
Request samples 
{
  • "email_address": "string",
  • "account_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "address": { }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "account_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "owner_email": "user@example.com",
  • "email_address": "user@example.com",
  • "url": "string",
  • "tech_email_address": "user@example.com",
  • "support_email_address": "user@example.com",
  • "support_phone": "string",
  • "compliance_email_address": "user@example.com",
  • "actions_email_address": "user@example.com",
  • "address": {
    },
  • "logo": "string",
  • "meta": {
    },
  • "permissible_purposes": [
    ],
  • "api_tokens": [
    ]
}
Get a subaccount
You can get the details of any subaccount that belongs to your platform account.


SecurityApiKey 
Request 
path Parameters
sub_account_id
required
string
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


404
Not Found


get/sub_accounts/{sub_account_id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "account_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "user@example.com",
  • "url": "string",
  • "tech_email_address": "user@example.com",
  • "support_email_address": "user@example.com",
  • "support_phone": "string",
  • "compliance_email_address": "user@example.com",
  • "actions_email_address": "user@example.com",
  • "configurations": {
    },
  • "features": {
    },
  • "company_phone_number": "string",
  • "additional_company_info": "string",
  • "owner_title": "string",
  • "legal_business_name": "string",
  • "state_of_incorporation": "string",
  • "ein": "string",
  • "legal_entity_type": "string",
  • "billing_contact_first_name": "string",
  • "billing_contact_last_name": "string",
  • "billing_email": "string",
  • "address": {
    },
  • "logo": "string",
  • "meta": {
    },
  • "permissible_purposes": [
    ]
}
➔ Next to Packages