# Account group events

Notifies subscribers of account group lifecycle events.
Triggered when an account group is created, activated, updated, locked, closed, or has its closure initiated.
See the Account webhooks guide ([TOL](https://docs.upvest.co/products/tol/guides/accounts/accounts_webhooks) / [BYOL](https://docs.upvest.co/products/byol/guides/accounts/accounts_webhooks)) for payloads and event sequencing.

Endpoint: POST Account Group events
Version: 1.154.0

## Request fields (application/json):

  - `id` (string, required)
    Event unique identifier

  - `created_at` (string, required)
    Date and time when the event was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `type` (string, required)
    Event type.
* `ACCOUNT_GROUP.CREATED` — An account group has been created.
* `ACCOUNT_GROUP.ACTIVATED` — An account group has become active.
* `ACCOUNT_GROUP.CLOSING_INITIATED` — Closure of an account group has been initiated.
* `ACCOUNT_GROUP.CLOSED` — An account group has been closed.
* `ACCOUNT_GROUP.LOCKED` — An account group has been locked.
* `ACCOUNT_GROUP.UPDATED` — An account group has been updated.
    Enum: "ACCOUNT_GROUP.CREATED", "ACCOUNT_GROUP.ACTIVATED", "ACCOUNT_GROUP.CLOSING_INITIATED", "ACCOUNT_GROUP.CLOSED", "ACCOUNT_GROUP.LOCKED", "ACCOUNT_GROUP.UPDATED"

  - `object` (any, required)

  - `object.id` (string, required)
    Universally Unique Identifier (UUID) of the account group.

  - `object.created_at` (string, required)
    Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `object.updated_at` (string, required)
    Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `object.users` (array, required)
    The users associated with the account group, each with their relation type.

  - `object.users.id` (string)
    Unique identifier of the user, as a UUID.

  - `object.users.type` (string)
    Relation of the user to the account group.
* `OWNER` — The user owns the account group. A `JOINT` account group has exactly 2 `OWNER` users.
* `CHILD` — The user is the child in a child account group.
* `GUARDIAN` — The user is a guardian of a child account group.
    Enum: "OWNER", "CHILD", "GUARDIAN"

  - `object.status` (string, 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"

  - `object.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.
* FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions.
* ISA - Account group of a UK resident holding assets in an individual savings account.
* CHILD - Account group of a child user holding assets in a child account.
* JOINT - Account group legally and beneficially owned by exactly 2 users. The user the account group is created with becomes the first owner and receives an OWNER role. The second owner is added by creating an OWNER role for them (POST /roles); no further owners can be added. The account group activates only once both OWNER roles are active.
    Enum: "PERSONAL", "LEGAL_ENTITY", "FRENCH_PEA", "ISA", "CHILD", "JOINT"

  - `object.securities_account_number` (string, required)
    Official securities account number, assigned at account group level. A string of 7 to 12 digits.

  - `object.business_id` (string, required)
    Unique identifier for the business.

  - `object.type` (string, required)
    Account group type.
* BUSINESS - Account group of a business holding assets.
    Enum: "BUSINESS"

  - `webhook_id` (string, required)
    Webhook unique identifier.

## Request examples:

  - `User account group event` (unknown)

  - `Business account group event` (unknown)

## Response 200:

  - `200` (unknown)
    Request has been processed successfully.