Read organisation
Returns the organisation of the API key or token: its profile (name, description, sector, location, privacy policy URL), its logo and cover images, the login methods of its admins, the deployment of its organisation wallet and privacy dashboard, and its features.
Update organisation
Changes the profile of the organisation of the API key or token: the name, the location, the description and the privacy policy URL. Send only the members that you change: an empty or missing member keeps its stored value, so you cannot clear a value with this operation. A new `policyUrl` must be an absolute `http://` or `https://` URL. The organisation wallet and the consent service get the change a moment after the response.
Read organisation logo image
Returns the logo image of the organisation of the API key or token, as image bytes. The `Content-Type` is always `image/jpeg`, also for a PNG, GIF or WebP image that you uploaded with [Update organisation logo image](/docs/openid4vc-api/onboard-update-organisation-logo-image). The same image is public at the `logoImageUrl` of [Read organisation](/docs/openid4vc-api/onboard-read-organisation).
Update organisation logo image
Replaces the logo image of the organisation of the API key or token. Send the image as `multipart/form-data` in the `orgimage` field: a PNG, JPEG, GIF or WebP image (the service reads the type from the bytes) of at most 5 MiB and 4096 x 4096 pixels (the defaults of the installation).
Read organisation cover image
Returns the cover image of the organisation of the API key or token, as image bytes. The `Content-Type` is always `image/jpeg`, also for a PNG, GIF or WebP image that you uploaded with [Update organisation cover image](/docs/openid4vc-api/onboard-update-organisation-cover-image). The same image is public at the `coverImageUrl` of [Read organisation](/docs/openid4vc-api/onboard-read-organisation).
Update organisation cover image
Replaces the cover image of the organisation of the API key or token. Send the image as `multipart/form-data` in the `orgimage` field: a PNG, JPEG, GIF or WebP image (the service reads the type from the bytes) of at most 5 MiB and 4096 x 4096 pixels (the defaults of the installation).
Read organisation features
Returns the features of the organisation of the API key or token. A platform admin of the installation sets them; the organisation cannot change them. By default the API rejects each route of a product feature that is off, also for an API key, with `403`: `{'errorCode': 403, 'errorDescription': 'The feature webhooks is not enabled for this organisation', 'errorKey': 'feature_disabled', 'feature': 'webhooks'}`. Read the features to find out which routes your organisation can use. A sandbox organisation has the features of its main organisation.
Read organisation type
Returns an organisation type (a sector), for example the type of your organisation. The `sector` of [Read organisation](/docs/openid4vc-api/onboard-read-organisation) is the `type` of the organisation type. A platform admin of the installation manages the organisation types; each organisation can read them.
Read API status
Returns the tenant mode and the version of the API. Use it to check that your API key works and which release of the API answers.