Skip to main content

Query account suspension information

Retrieve suspension reasons for accounts with the status Suspended using the API. Reasons tell you whether the account holder needs to act, such as responding to a KYC request, or whether Swan is handling the review and no action is needed from you.

When an account has the status Suspended, the statusInfo field returns AccountSuspendedStatus. Its suspensionReasons array lists every active reason, each with a type. The array is empty for accounts suspended before 21 September 2026, and for some suspensions triggered before this date but applied in the following weeks.

Refer to the suspension reasons for a full list of possible values.

Deprecated fields

The reason and reasonInfo fields on AccountSuspendedStatus are deprecated as of 2 November 2026. Use suspensionReasons instead.

Guide​

  1. Call the account query.
  2. Add the account ID (line 2).
  3. Add statusInfo with AccountSuspendedStatus, then select suspensionReasons and type to retrieve the active reasons (lines 5-9).

Query​

Retrieve suspension information for a specific account.

Open in API Explorer
query GetSuspensionInfo {
account(accountId: "$YOUR_ACCOUNT_ID") {
statusInfo {
status
... on AccountSuspendedStatus {
suspensionReasons {
type
}
}
}
}
}

Payload​

The following example shows an account with two active suspension reasons. The account stays Suspended until both are resolved.

{
"data": {
"account": {
"statusInfo": {
"status": "Suspended",
"suspensionReasons": [
{ "type": "ComplianceReview" },
{ "type": "KYCReview" }
]
}
}
}
}

The following example shows an account with no recorded reason, such as an account suspended before 21 September 2026. In this case, suspensionReasons is empty.

{
"data": {
"account": {
"statusInfo": {
"status": "Suspended",
"suspensionReasons": []
}
}
}
}

Refer to the account statuses section for an overview of what happens while an account is Suspended.