Account Groups

Download Spec

All account groups related paths

Get user account groups
get /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.

Default
"created_at"
Enum
  • 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.

Default
"ASC"
Enum
  • ASC
  • DESC

offset

int

i32

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

Min
0

limit

int

i32

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

Default
100
Min
0
Max
1000

Response

ExamplesSchema

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"
    }
  ]
}

Get an account group by ID
get /account_groups/{account_group_id}

Returns the account group specified by its ID.

account_group_id

string

uuid

required

Account group unique identifier.

Response

ExamplesSchema

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"
}

Close an account group by ID
delete /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.

Enum
  • dunning
  • power_of_attorney
  • loss_of_legal_capacity
  • aml
  • risk_based
  • contract_breach
  • user_initiated

notification_only

boolean

Indicates whether the request notifies of an intended future closing.

Response

ExamplesSchema

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.

sort

string

Sort the result by created_at, updated_at.

Default
"created_at"
Enum
  • 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.

Default
"ASC"
Enum
  • ASC
  • DESC

offset

int

i32

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

Min
0

limit

int

i32

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

Default
100
Min
0
Max
1000

Response

ExamplesSchema

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"
    }
  ]
}

Create an account group
post /account_groups

Creates an account group.

user_id

string

uuid

required

User unique identifier.

type

string

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

Request

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

Response

ExamplesSchema

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"
}

Account group events
webhook

Account group events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

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

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "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

ExamplesSchema

Request has been processed successfully.

Empty response

Was this page helpful?