Users & Accounts Management

Account Groups

Download Spec

All account groups related paths

get/users/{user_id}/account_groups

Get user account groups

Lists the account groups of a user specified by ID.

sortstring

Sort the result by created_at, updated_at.

Default: "created_at"
Enum: created_at
updated_at

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "created_at": "2020-08-24T14:15:22Z",
      "updated_at": "2020-08-24T14:15:22Z",
      "type": "PERSONAL",
      "status": "ACTIVE",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ],
      "securities_account_number": "123456789"
    }
  ]
}

get/account_groups/{account_group_id}

Get an account group by ID

Returns the account group specified by its ID.

account_group_idstring

required

Account group unique identifier.

Format: uuid

Responses

Response examples

{
  "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "type": "PERSONAL",
  "status": "ACTIVE",
  "users": [
    {
      "id": "413715f2-5401-4b97-8055-034a6b879f8c",
      "type": "OWNER"
    }
  ],
  "securities_account_number": "123456789"
}

delete/account_groups/{account_group_id}

Close an account group by ID

Initiates the closure request for an account group specified by its ID.

closure_reasonstring

Records the reason for the account group closure.

Enum: dunning
power_of_attorney
loss_of_legal_capacity
aml
risk_based
contract_breach
user_initiated

notification_onlyboolean

Indicates whether the request notifies of an intended future closing.

Responses

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

get/account_groups

Get account groups

Returns a list of all account groups.

sortstring

Sort the result by created_at, updated_at.

Default: "created_at"
Enum: created_at
updated_at

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "created_at",
    "order": "ASC"
  },
  "data": [
    {
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "created_at": "2020-08-24T14:15:22Z",
      "updated_at": "2020-08-24T14:15:22Z",
      "type": "PERSONAL",
      "status": "ACTIVE",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ],
      "securities_account_number": "123456789"
    }
  ]
}

post/account_groups

Create an account group

Creates an account group.

user_idstring

required

User unique identifier.

Format: uuid

typestring

required

Account group type.

PERSONAL - Account group of a person holding assets on their own behalf.
LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users.

Enum: PERSONAL
LEGAL_ENTITY

Responses

Request examples

{
  "user_id": "413715f2-5401-4b97-8055-034a6b879f8c",
  "type": "PERSONAL"
}

Response examples

Account group created.

{
  "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "type": "PERSONAL",
  "status": "ACTIVE",
  "users": [
    {
      "id": "413715f2-5401-4b97-8055-034a6b879f8c",
      "type": "OWNER"
    }
  ],
  "securities_account_number": "123456789"
}

webhook

Account group events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: ACCOUNT_GROUP.CREATED
ACCOUNT_GROUP.ACTIVATED
ACCOUNT_GROUP.CLOSING_INITIATED
ACCOUNT_GROUP.CLOSED
ACCOUNT_GROUP.LOCKED

objectobject (Account Group)

required

idstring

required

Account group unique identifier.

Format: uuid

created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format: date-time

updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format: date-time

usersarray

required

statusstring

required

Status of the account group

PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on.
ACTIVE - Account group is active - full functionality of the Investment API is accessible.
CLOSING - Account group is closing.
CLOSED - Account group is closed.
LOCKED - Account group is locked for all actions.

Enum: PENDING_APPROVAL
ACTIVE
CLOSING
CLOSED
LOCKED

typestring

required

Account group type.

PERSONAL - Account group of a person holding assets on their own behalf.
LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users.

Enum: PERSONAL
LEGAL_ENTITY

securities_account_numberstring

required

Securities account number

Pattern: ^[0-9]{9}$

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "72da9e41-9926-419f-976e-4c8069a04249",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "ACCOUNT_GROUP.CREATED",
  "object": {
    "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
    "created_at": "2020-08-24T14:15:22Z",
    "updated_at": "2020-08-24T14:15:22Z",
    "type": "PERSONAL",
    "status": "ACTIVE",
    "users": [
      {
        "id": "413715f2-5401-4b97-8055-034a6b879f8c",
        "type": "OWNER"
      }
    ],
    "securities_account_number": "123456789"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?