Update My Consumer Organisation
PUT /obp/v7.0.0/my/consumers/CONSUMER_ID/organisation
OBPv7.0.0-updateMyConsumerOrganisation No role required ConsumerOrganisation
Move one of your Consumers into an Organisation, or out of it with organisation_id null.
Moving a Consumer into an Organisation needs you to be an admin of that Organisation, which must be active. A Consumer that already belongs to an Organisation can only be moved by an admin of it. Once a Consumer belongs to an Organisation, its members act for it, and its creator no longer does on their own. Moved out, it belongs to its creator again.
You may read a Consumer here if you created it and it belongs to no Organisation, or if it belongs to an active Organisation you are a member of. Any other CONSUMER_ID answers 404. The consumer key and secret are never returned.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields (11)
- app_name
- appNameBank
- app_type
- Web
- company
- Tesobe GmbH
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- created
- created_by_user_id
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- developer_email
- enabled
- false
- redirect_url
- https://apisandbox.openbankproject.com
- organisation_id
- 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
Example request body
{
"organisation_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"
}Example success response
{
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"app_name": "Example Payments App",
"app_type": "Confidential",
"description": "Pays bills.",
"developer_email": "dev@fintech.example.com",
"company": "Example Fintech Ltd",
"redirect_url": "https://app.fintech.example.com/callback",
"enabled": true,
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"organisation_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"created": "1100-01-01T00:00:00Z"
}Possible errors (8)
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30643: Consumer not found. Please specify the CONSUMER_ID of a Consumer you created or one that belongs to your Organisation.
- 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-30637: Invalid Organisation status. Allowed values are: active, suspended.
- OBP-30644: Could not change the Organisation of the Consumer.
- OBP-50000: Unknown Error.