Account Statuses

The status of an account can be one of the following:

The status can change from:

Close Account

The accountClose can be used to close an opened account based on the accountId. Within the body of the request, include reason for account closure (closeReason).

• Accounts eligible to be closed must have current status of O or Q and must have a cleared balance. If an account is funded at the time which the closure request is submitted, the request will be rejected.
• If status Q account is closed, status will move to R (rejected)

Requests are processed between 8am EST to 11am EST. Requests received outside of these hours will be processed the following day.

Example

POST /gw/api/v1/accounts/close
{
  "accountManagementRequests": {
   "accountClose": {
      "accountId": "U1233457",
      "closeReason": "time to go"
    }
  }

Reopen Account

The reopenAccount can be used to reopen an opened account based on the accountId.

• The following accounts are eligible for reopening:
  • Fully-Disclosed and Advisor subs that originate using Hybrid
  • Current status of C (Closed)

Once the reopen request has been submitted, the end user must log into the IBKR Portal to review application information and sign updated agreements and disclosures. The request will not be processed until this step is completed.

Example

PATCH /gw/api/v1/accounts
{
  "accountManagementRequests": {
   "reopenAccount": {      
   "accountId": "U1233457"
    }
  }

Cancel Application

The abandonAccount can be used to delete/cancel a pending application based on the accountId. Once the request is processed, the account will no longer appear in IBKR’s CRM as a PENDING account.

• Accounts eligible to be abandoned must have current status of P or N.

Example

PATCH /gw/api/v1/accounts
{
    "accountManagementRequests": {
        "abandonAccount": {
            "accountId": "U12345"
        }
    }
}

Reset Application

The resetAbandonedAccount can be used to reset application that was previously marked abandoned based on the accountId. Accounts eligible to be reset must have current status of A and be less than 6 months old. Once the account has been reset, user can proceed with registration process.

Example

PATCH /gw/api/v1/accounts
{
    "accountManagementRequests": {
        "resetAbandonedAccount": {
            "accountId": "U12345"
        }
    }
}

View Status by Account

The /gw/api/v1/accounts/{accountId}/status can be used to query the status by account. In addition to the status of the account, the response will include the following information:

View Status for Group of Accounts

The /gw/api/v1/accounts/status can be used to filter custom group of accounts associated with masterAccountId based on the following criteria:

Queries returning more than 10,000 results will trigger a timeout error, Implement pagination using ‘limit’ and ‘offset’ parameter to manage large result sets.

Account Status Scenarios

The endpoint will return both a “status” and “state” that indicate where the account is in the account setup process. The below table will help you understand what these values mean and what actions need to be taken.