Organisations

Delete organisation

DELETE/v4/onboard/platform/operator/organisation/{organisationId}

Starts the deletion of a suspended organisation. The deletion cannot be undone. The organisation gets the state deleting, and the API deletes its data of the organisation in steps: the sessions, the admins, the API keys, the data verifier users, the webhooks, the identity providers, the extension instances, the OpenID provider tenants, the sandbox organisations, the tickets, the individuals and the images. After the answer, the consent service purges its data of the organisation, and the organisation wallet deactivates the wallet of the organisation and purges it after its grace period. See Deletion.

When deletion.status is incomplete, send the same request again: for an organisation in the state deleting, the API runs the steps again and answers 202 again.

Delete organisation

Language of the request sample

curl -X DELETE 'https://demo-api.igrant.io/v4/onboard/platform/operator/organisation/6731f0c2a1b2c3d4e5f60789' \
  -H 'Authorization: Bearer <access-token>'

{
  "organisation": {
    "id": "6731f0c2a1b2c3d4e5f60789",
    "name": "Acme Bank",
    "location": "Stockholm, Sweden",
    "type": {
      "id": "64e0c1a2b3c4d5e6f7a8b9c0",
      "type": "Banking"
    },
    "policyUrl": "https://acme-bank.example.com/privacy",
    "status": "deleting",
    "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
    }
  },
  "deletion": {
    "status": "completed"
  }
}

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"

Response

application/json

The deletion started.

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.
deletionobject
The result of the steps of the API.