Get closure information using the API

Retrieve closure reason codes and closure dates for accounts with the status Closing or Closed using the API.

When an account has the status Closing or Closed, the statusInfo field returns either AccountClosingStatus or AccountClosedStatus. Both types include a reasonInfo object with the closure reason type. AccountClosingStatus includes closingAt, while AccountClosedStatus includes both closingAt and closedAt.

Refer to the closure reason codes for a full list of possible values.

Guide

1. Call the account query.
2. Add the account ID (line 2).
3. Add statusInfo (line 3) with AccountClosingStatus or AccountClosedStatus to retrieve the closure reason and dates (lines 5 and 13).

Query

Retrieve closure information for a specific account.

Open in API Explorer

query GetClosureInfo {
  account(accountId: "$YOUR_ACCOUNT_ID") {
    statusInfo {
      status
      ... on AccountClosingStatus {
        reasonInfo {
          ... on CloseAccountReason {
            type
          }
        }
        closingAt
      }
      ... on AccountClosedStatus {
        reasonInfo {
          ... on CloseAccountReason {
            type
          }
        }
        closingAt
        closedAt
      }
    }
  }
}

Payload

The following example shows an account with the Closed status. The reasonInfo object confirms the closure was RequestedByHolder.

{
  "data": {
    "account": {
      "statusInfo": {
        "status": "Closed",
        "reasonInfo": {
          "type": "RequestedByHolder"
        },
        "closingAt": "2026-01-15T10:30:00.000Z",
        "closedAt": "2026-03-16T10:30:00.000Z"
      }
    }
  }
}