Organisation

Read organisation

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

Read organisation

Language of the request sample

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

{
  "organisation": {
    "id": "6ae2bf741c3dadfeb27982ec",
    "name": "Acme Bank",
    "description": "Retail bank that issues and verifies payment credentials.",
    "sector": "Banking",
    "location": "Stockholm, Sweden",
    "policyUrl": "https://acme-bank.example.com/privacy",
    "coverImageUrl": "https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ed/web",
    "coverImageId": "6ae2bf741c3dadfeb27982ed",
    "logoImageUrl": "https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ee/web",
    "logoImageId": "6ae2bf741c3dadfeb27982ee",
    "eulaUrl": "",
    "enabled": true,
    "authentication": {
      "password": {
        "enabled": true
      },
      "oidcPasswordless": {
        "enabled": false,
        "loginPresentationDefinitionId": "",
        "linkingPresentationDefinitionId": "",
        "authenticatorCredentialDefinitionId": ""
      }
    },
    "privacyDashboard": {
      "hostname": "",
      "version": "",
      "status": 0,
      "delete": false,
      "buttonLabels": {
        "dataUsingServicesButtonLabel": ""
      }
    },
    "openIdDeployment": {
      "openIdDigitalWalletId": "5961c261-f35f-4d21-9fd4-79d9f550ba33",
      "status": 2,
      "ledgerId": 0,
      "infrastructureProvider": "iGrant.io",
      "version": "1.0.0",
      "role": "",
      "trustAnchor": "",
      "isWalletProvider": false
    },
    "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
    },
    "subscribeMethod": 0,
    "subs": {
      "method": 0,
      "key": ""
    }
  }
}

Authorizations

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

Response

application/json

The organisation.

organisationobject