Organisation
Organisation
An Organisation is a group of people that uses the APIs and owns Consumers. It is most likely a fintech or another external group, or an informal group within a bank. It has members.
An Organisation has no direct legal relationship with a bank. That is what a Customer is: a legal person or entity with a formal relationship with a bank on this instance. Where an Organisation does have such a relationship, it comes through a link to the Customer the bank keeps for it. That link is not built yet.
An Organisation is not a here either. A Tenant is a customer of the operator of this OBP instance. The fintechs building on a bank's APIs are one level down.
Anyone who is logged in can create an Organisation, and becomes its first admin. Each member is an admin or a member. An Organisation always keeps at least one admin.
Who may act for a Consumer
No Role is needed to act for your own Consumers:
- A Consumer that belongs to no Organisation is owned by the User who created it.
- A Consumer that belongs to an active Organisation is owned by the Organisation's members. Its creator no longer owns it on their own, so it stays with the team when someone leaves.
Owners read their Consumers, their usage, Scopes and API Product Subscriptions under /my/consumers, and subscribe them to API Products. Admins also change the Organisation and its members, and move Consumers into or out of it.
Sharing Dynamic Entity records
A record of a Dynamic Entity with row-level access can be shared with an Organisation as well as with single Users: PUT .../RECORD_ID/access with an organisation_id. Every member of the active Organisation then holds the permissions given, and access follows membership. See here.
bank_id
Every Organisation has a bank_id: the space that administers it. It says where staff Roles for the Organisation are held, and it never changes. It is not a legal relationship with that bank.
An Organisation you create for yourself is always at SYS. Only staff with CanCreateOrganisationAtOneBank at a bank can create an Organisation there, so each bank decides which Organisations it administers. An application that only needs to know which Organisation is which, such as a programme recording its startups' teams, keeps the organisation_id in its own records.
Staff
Staff Roles are held at the Organisation's bank_id. With CanCreateOrganisationAtOneBank, staff create an Organisation for someone else and name its first admin, for example when a regulator registers a participant. With CanGetOrganisationAtOneBank they read Organisations and their members. With CanUpdateOrganisationStatusAtOneBank they suspend one: its members still see it, but cannot act for its Consumers.
Endpoints
- Create My Organisation:
POST /obp/v7.0.0/my/organisations - Get My Organisations:
GET /obp/v7.0.0/my/organisations - Add My Organisation Member:
POST /obp/v7.0.0/my/organisations/ORGANISATION_ID/members - Update My Consumer Organisation:
PUT /obp/v7.0.0/my/consumers/CONSUMER_ID/organisation - Get My Consumers:
GET /obp/v7.0.0/my/consumers - Get My Consumer Usage:
GET /obp/v7.0.0/my/consumers/CONSUMER_ID/usage - Create Organisation:
POST /obp/v7.0.0/management/organisations - Get Organisations:
GET /obp/v7.0.0/management/organisations - Get Organisation Members:
GET /obp/v7.0.0/management/organisations/ORGANISATION_ID/members