All account groups related paths
/users/{user_id}/account_groups
Lists the account groups of a user specified by ID.
sort
string
Sort the result by created_at
, updated_at
.
order
string
Sort order of the result list if the sort
parameter is specified. Use ASC
for ascending or DESC
for descending sort order.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
OK
{
"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"
}
]
}
/account_groups/{account_group_id}
Returns the account group specified by its ID.
account_group_id
string
required
Account group unique identifier.
OK
{
"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"
}
/account_groups/{account_group_id}
Initiates the closure request for an account group specified by its ID.
closure_reason
string
Records the reason for the account group closure.
notification_only
boolean
Indicates whether the request notifies of an intended future closing.
The request has been successfully accepted and will be processed asynchronously.
Empty response
/account_groups
Returns a list of all account groups.
sort
string
Sort the result by created_at
, updated_at
.
order
string
Sort order of the result list if the sort
parameter is specified. Use ASC
for ascending or DESC
for descending sort order.
offset
int
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
limit
int
Use the limit
argument to specify the maximum number of items returned.
OK
{
"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"
}
]
}