Organisation

Read organisation features

GET/v4/onboard/platform/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.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/onboard/platform/organisation/features' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "configuredFeatures": {
    "gettingStarted": true,
    "dataAgreements": true,
    "dataDisclosureAgreements": false,
    "managedData": true,
    "issuerVerifier": true,
    "walletUnit": true,
    "consentManagement": true,
    "privacyDashboard": true,
    "account": true,
    "actionLogs": true,
    "webhooks": true,
    "files": false,
    "sandbox": false,
    "apiKeyScopesUi": true
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation:read

Response

application/json

The features of the organisation.

configuredFeaturesobject
The features of the organisation: 13 product features and 1 preview (apiKeyScopesUi). The dashboard shows or hides its pages with them, and by default the API rejects each route of a product feature that is off with 403 and the errorKey feature_disabled. A sandbox organisation has the features of its main organisation. Only a platform admin of the installation can change them.