API Explorer 891 endpoints

Delete My Organisation

DELETE /obp/v7.0.0/my/organisations/ORGANISATION_ID

OBPv7.0.0-deleteMyOrganisation No role required Organisation

Delete an Organisation and its memberships. Only its admins may, and only when no Consumer belongs to it.

An Organisation is a company or team that uses the APIs, for example a fintech, and owns Consumers. Its members are admins or members. Members may act for the Organisation's Consumers without a Role: read them, their usage, Scopes and API Product Subscriptions, and subscribe them. Admins also change the Organisation and its members, and move Consumers into or out of it.

Its bank_id is the space that administers it, and staff Roles for Organisations are held there. An Organisation you create for yourself is at SYS. Only staff with CanCreateOrganisationAtOneBank at a bank create one there. The bank_id is not a legal relationship with that bank, which is what a Customer is. An Organisation is not a Tenant either: a Tenant is a customer of the operator of this instance.

Authentication is Required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ORGANISATION_ID: 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0

JSON response body fields (0)
Possible errors (6)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30630: Organisation not found. Please specify the ORGANISATION_ID of an Organisation you belong to.
  • OBP-30631: Only an admin of the Organisation can do this.
  • OBP-30636: The Organisation still has Consumers. Move them out of it first.
  • OBP-30641: Could not delete the Organisation.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 deleteMyOrganisation