Organisations

Suspend or resume organisation

PUT/v4/onboard/platform/operator/organisation/{organisationId}/status

Suspends (suspended) or resumes (active) an organisation. A suspension can be undone: the data, the keys and the wallet units of the organisation stay, and no credential is revoked. While the organisation is suspended, each call with its API keys or the logins of its admins gets 401 with errorKey organisation_suspended, and its organisation wallet refuses its operations; the status lists, the issuer metadata and the JWKS stay available. See Suspension.

The answer is 200 when the API has the new state. walletSuspension tells whether the organisation wallet has it also. With failed, send the same request again: a request for the state that the organisation has changes nothing in the API and sends the state to the wallet again.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/onboard/platform/operator/organisation/6731f0c2a1b2c3d4e5f60789/status' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "suspended"
}'

{
  "organisation": {
    "id": "6731f0c2a1b2c3d4e5f60789",
    "name": "Acme Bank",
    "location": "Stockholm, Sweden",
    "type": {
      "id": "64e0c1a2b3c4d5e6f7a8b9c0",
      "type": "Banking"
    },
    "policyUrl": "https://acme-bank.example.com/privacy",
    "status": "suspended",
    "isPlatformOperator": false,
    "superAdminCount": 1,
    "createdAt": "2026-11-12T08:15:00Z",
    "suspendedAt": "2026-11-12T11:00:00Z",
    "wallet": {
      "deploymentStatus": "deployed",
      "walletOrganisationId": "2f6c1d0e-8b7a-4c3d-9e1f-0a2b3c4d5e6f",
      "isWalletProvider": false
    },
    "features": {
      "enabled": 1,
      "total": 4
    }
  },
  "walletSuspension": {
    "status": "applied"
  }
}

Authorizations

Authorizationstringheaderrequired
An access token: Bearer <access-token>.

Path parameters

organisationIdstringrequired
The ID of the organisation, from List organisations of the installation.
At most 256 characters.
Example:"6731f0c2a1b2c3d4e5f60789"

Body

application/json

statusenum<string>required
suspended suspends the organisation; active resumes it.
Available options:suspended,active
Example:"suspended"

Response

application/json

The organisation has the new state in the API.

organisationobject
An organisation of the installation as a platform admin sees it: its profile and its state. It has no data of the organisation, such as its credentials, records or keys.
walletSuspensionobject
The result in the organisation wallet.