Customer account status update notification provides information about the changes in the status of a multiple tenant customer account. A notification is emitted whenever the customer account status changes with the latest details of that customer account.
Note: The x-zh-hook-payload-type must be set to customer_account_status_changed.
Once a platform is set up to receive customer account status webhooks, the payload is a JSON object containing the following fields:
| Field | Description | Type |
|---|---|---|
urn | The unique identifier for the customer account | string |
participant_code | The zero hash identifier for the customer | string |
prefunded | Indicates whether the participant has prefunded their account or not | bool |
account_label | Account label associated | string |
account_group | The group that the account is a part of | string |
tier | The account tier associated with the account. Possible values: gold, silver, bronze | string |
type | The type of joint customer account | string |
status | The status of the customer account, which indicates if the account can be used or not. Possible values: open, closed, locked, divesting | string |
tenants | The list of tenant participant codes | array |
financial_advisors | The list of identifiers of financial advisors associated with the account | array |
Customer account statuses
The following statuses are emitted via webhook. Platforms are notified at customer account creation and at any point throughout the lifecycle of the customer account.
| Status | Description |
|---|---|
open | Account is open and can be used |
closed | The account is closed and no further activity is allowed |
locked | The account is locked |
divesting | The account in divesting status allowing only SELL trades and withdrawals |
Payloads
Customer account status change payload:
{
"urn": "urn:zh:us:accounts:customer:c761fc96-5c44-40d4-8eb2-3fcd5d06754e”,
"participant_code": "CUST01",
"prefunded": true,
"account_label": "U12345678",
"tier": "pro",
"account_group": "IBKR01",
"type": "jtic",
"tenants": ["CUST02"],
"financial_advisors": ["ADVSR1"],
"status": "open"
}