---
id: onboard-read-organisation
title: "Read organisation"
description: "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."
sidebar_label: "Read organisation"
hide_title: true
hide_table_of_contents: true
api: eJztW21v3DYS/iuEvpwNaF/8kvayLYJzbbfYNm2MOG4OSI2KK82ueJZIlaR2sxfsfz8MSVGva6+bFDgc7kvilcjhcDicefgM9SlIQMWSFZoJHsyCt6BLyRXRKRAhV5QzRfEVEUvz7OJmTh5gS4QkWjwAnxGmFSmkWLIMyBGnOYSkITIkCmItZEgyEVP7pJBsTeMtKUTG4i25e/v6ODRiMrEShPKExGINkrCcrkCFZtxMrBgnOehUJAqVwfY0yRl3DRIoMrHNgevqbUv9Dc0y0EZ4NXxCVboQVCaheYxdlkB1KUGNgzAQBUjTd54Es0Bw0/Qt0ORNQ24QBhJUIbgCFcw+BafTKf7Xtum7ji1Reiy4Bq6xMS2KjFnbTP6lsMenQMUp5BT/0tsCcPzFvyDWZrg/SiYhCWYfgqbQ4D4MColKa2Z1ab0dkKSZzvBBbz71ACwJwgDXNAhbcwoDu6pBGFTLGoSBXc87mZn5rUHOcQG7v+eJ6bUSjbf+p3kJZUbtc+B0kQE+o6VOgWtWD2ZX8apaRLtifJ5ceUewZl6yVSkh+d4tLepeLnAqC/jZuJN70jcgSxpmU1oyvurYob+2ZH6FywsfaV4Y635F4XSx/Pr8JD5LaLKExenXL/9+CnGwc5Y9aAhsWW3BliuRuSZMkZKzP0ogjJsWjCtNs8w7W63NRZwD+Y7yBxy+NcxTWlwQlQqpm3t7SKGQUE1yoTR5MZ2SOKWSxhqkaqvxFjRlGVlQ/kB0SnEKqgRl9uEaJFsyUKSgdjvHEhJcepqpMartXO+z7EawKzmyoo4HLdtSGE2GY+waDn+QAlXrp4e41SJ+SEWWh+R2gzPGweotddBod29fVwN1guyTw6daF2o2mdA4hxEuzNi9G8cinzhpqFJ7Zz9XrUZkH5PvhSSUk7LIBE0gsY8JMx4dfYupZkGV6f5qsj6fuBg8KTKql0LmE9N+8qkZW3aTDSyikGxSFqeEAySKcEHa4WNMrvNCb8kmBd53jZSaLk1NBy2VQC5GtGBjtpKU6zETjyi5JwwkqG7bqvMDo878atCmnzOzfUpat29E7OeuuknsX3bRGynjy615Q8+/bMmhWvJm0nvmijft+RnT2qchalcl4ecuNfBkVCqQJGMx8BgIXUmACpf189ebpQZOACfRVs4o4fJ/rcRCiAwo72nxPgWdguybgCnipLTEa1nCrgcrBlDSUEjvQFEc00LRfWG2iakKqtRGWMDCkvjG/cxADUAQ3/gJJFgZqifgz1nQzSamHGeLsGLDdEooqfTp23K3G5jPgVqbvcD4jQQFXBurXcGScebgdxhkzOTfR1o0VlLISw8ZWq3+auu4Q8ZR0bCBdZfjlsGWNFOwe2rWz4wJRUMOSbyg6rXTzQzZCho28nKhiQLd34JPWf4LaWlQII6lajtqPAxaaz9H40M84bkZ1ksZsCz7weUCctEcudHpcO13Zh/1zjYHxaX2CbiJAf1J95D4lAql3ZFvDVK5456mulRm2Aw0vluUWgv+mi4gG4hbXshBhsbWLajeU3yPBe2UO6HdOEGl+kHju8ZfbnRnrnpwxjWsQJojbZkHsw/T8CQ8vX9iGa2YGYmmkRmwPs2GJDqJCC4bKG1+nkbD+kx3ftEOj3KU2C77HYmpevTB2NbyjyfyQEI1vVOMr25BrlkM6ru6c9+3Hm192KEMm1Zzs4raAKRSsbHcFw5CShyFKDdM5QVLIR3jtKRlpq204Y3cYyT+5EYeoLIskMaXTj9EXoVgXKt2yEcGDsgHZK5IwlZM06wKsPVA90eTRMRqggqz5HwdI8qdWH8bSaDJyHUd2a4jbDhiyXE3ergZ28bvTVuTnn0AySBZgTTPGF9KqrQsY2RmbqRYs8TskTruSJFhsNGyVPqCx6mhnJiygn2PPvU1qMUzg/6g0Tto2xny0YDw4uVXJ/HpVyej5dmL5eg8OT0ZvVwm56OvXyYvly9eTBf07Oy/LGic7hoLNaRQW4NfhEYUVCogR9E0Ou4FoD0rfdCCFK613aGydOR05dyRT7+R2ZnUz6has9Zi+NafmyRqi7cHOBlPx1MUblz3Scm16cbkTpU0y7b7DkPNTfAl5fa20+edthrbwi9dhZT28ZI2aex2g4TtgdS1J+8HV696ObS5Z+TkDHVNyljXDZGLPEG8umawIUcRLdhPsL2NRQHqjkXHY2I2ns+INncISVKWgLJlEaxf2MOBTiG3dYbF1meOqqAiAeelCNA4JVKUNvHSrk4VVUrEcmmlRufTs8hIRVERSCnkT7CNSOS6/J4wZY440ZhcEEV5shAf+xyB7lgIlc8p492zOs+2qJbjOSw0H1pcczaKU8pXYGbezRIr0BoTuKZSm/MfptuLiihQ7sEVU3EmVCmh9SqnnK4guaKammSgSpC/WtIYQ5P1vTvOHP+Px42fTRdXExioHNA4FqV5SWPU/7VY4UgbWKRCPOCfWN4ytQNrQmzZ8od+DurM8elNhe70g+1EXC/jQT7i1HD0F+HcJIECOLIQiEuHCI6OYQ/TwoAfz9so72CrTCzwCISvDa/MEBXNNVlRDao6KVENISmLhGowPWsoSTuSiYnXlqEO/SgIN7C14F1NrNOjc9rnWku2KLXbrLhTMUIrchQhLWdDycS5wAS7jLyoyXg8rvZwxpR2VUQcW7nNZ4nzSqsKZRm7K5KIKuMDTx43/6AbP2MhEt9/aE1ME1XQGB6Zdi2itgAaICR7uxiRxkrVUEx2jDBMajS352GzvAGpBKcZuTKO9bku34kIh+lgOzULULJa6pZZxUZNbNtJ34D4suptHcwvE3zUwAe803PGvoF1zIF5NQLbYXNKRZbU09iPavsztD0ne1Xph9UDrcwTtmZJSTO335hhSPTWQ4XasYtSpbjH2NKxsx7J7i2oNWOIAbk2mdWDDs3lEbLlsan0j8RD7uKX1zUf1R69z7ZVLjpMDQ00HzaFDw7en5GWr+3rbnIM2qSRBQ9TAzuscR0zsUIT/HD9jqAZaJkwXVvBAIYJttnj4lXCPWzUqnnowhOsMUlgR9UIWglkDG2wd22cmL0rYnP/0yodEKKqIFnBiC8qtINInpZ94eFtN97O7BE3QgtEYftdgyVROBYpWPxQg3zvVweHbMT93TsZTx860QEUcoZrmpVAqCIRChnbwkzUO4OaOx4H8S9OF3vHQVlEpmqY66PJcEHLz7phDwVaDQLhvLqB8gDbPoTM99uiNTXsPHAi7PJRaGf/rH8/CK+77L+uUt1WaVwh6druz9/qqC91+JsWzYsWA3cjWlcjDry80Lu78BeU8ruV/P019W5J/S8oMndqzPvrvY1yb9C4dmW251CRtFmWbDXeUwT0bUyoerLwFRxQ8TONDir1oPcPp/m6ShE0WEfzoyLjpjV77nTvEtuP09F28CEeeA9HeRhdWCt42mTqpvuptgbz1ZyqpasqtirocK3mQZ8fqhLOMFnTPfhaJ+oeROunw+cjZ+3WacL26eJ7+7SJju2TAZBqX/Rdwfl5hbyqnzUIcmN4eGJ/O2DgVPU53f3upmO3P3qZblrnprx+ZGK6LySkQBEcB7NP+Ot8eoKtD75D2qq5I0d0KRKz6fHvq0YMvw976bFTMPe9H01K51NMSz3xj+ao72hCGC9KTQoqaQ4aZFAJ+Wk4wXXRjIaPyHcnPvdKWJaKZjYbJQIsTe+IKU/i227moXIklxK5761IStd4Qyk0BLPTmETN/Pm7KhViHEjwSNgj35DoiIpSFkLB7/AR+YZoXK1tH4BEWEgWkv3byI6IXX1k/nKmMNSExNV+utexq0rEmmbMUPpdxzkbvp7ck+ONRbNMbIhOGV54yLIxueC+NdIxotQNKFghouruNFk55EPsWXQhki2JPv0WoA/9FoTkt+BnUIqu4LdgFxnh0T9Ht3YnvZGreeJnb9YQozUCCmHo50E+U6fU3YTi0MGkVhsc3vux1aHrqVaZ9+ggPbrT8KWl5JAYHrZBnfZnX5UK+yczytUGpBH2KG3rj2s55AuQvkVEjnTnfqt7c/ys6+WUb98sg9mHzwkSu/ARht4su5FhFn8QcNev/XWqOMa7M3EK8YN/VjB7wBdLtz9bxAYtGImFhC7EdtNwbhbc7+7bMNhGs/PpWd1mFtxx6rYgJE6Zb+7wVhvuC/43bUMCcFGuUlKANPtScPVNMBiuz/8frv+Hw3Ur/MSUo9ILyyXPSPQ9ZRkkeJlpBdq1tYEdS0HzKzL7tilgnryKuoHbXnovJdNbs1UvDLLofgEywwHRv8NAUwQtH9qfdtyHHl8gRkNnoToNZsHg8aJ1OsTx5dqo86GbPq4gF8S+DsKgfOIoY4JFW8CNrXLZw/agmKck3Gq6qm5qDHRX9nVXkfvaqre49+yWqWzr3dfCOHNdAWWaZWmchpuZuufjt9Am26oPNPYk+KpSiLTMkn0kkVWGROTI3TA0rPzxrCNgRlzDb2nBRg+wfRWNyaWpxBDaHLfmcEqOA15YxEtekStYQ4ahA1VVWCzEbgoxvKtgRmKjHn6PvmlLtGn9x/fviEmRRxFsf7TMt82159OTaEyusbBZp0WbxWvUYPY7/kTB5v72zI1SIQymvbyzqNLOqNXI8lYXI1KRyB5O7F523h3ZuiTNMqQK5dYRNdYWDWrQdmpsi3pIIR+Qx8pqA7Q+ktuPSbS7OLYQJfqEmFUlJIU+0gM9rtJFjh7FOrVNsJQliIQiw0qQMV7oinGEEo4UH8eynLKREY/NVWHOmQ4bIObB7/gGQY+Pmf15H9FMCUKXGlEqludQstnQ9hB4HDqDG9v7Kl4NydBNnJs10NCekG2rdq524b2qX6iJjm0lb/+SbKjTFbO8RWTR+cm0UqU1fgKG5KYaNTCnesaXokrsNDaJHXLKMPSosiiE1P+ow42PGM1zeDtONUPcUPGkvmd6Mx+Els4mM0u8NSk2O6E3SDlcnf96OScn42loSbmtISbbDW7seywDtaSw1q0nsSRbUcqBEgyNNRKytHsRxBSLnW0UmV+/+57cXo0wevx6GZL57ZvJ/PqSnPx9enI2ekHyRMTkKL96bcto788uya+X5OjH9++Om1pZQH19dzUn7+uvPK9LREKUk+/wFh+CyfdeF3Nur4tFjoMhl42ZXtzMx4aFioErA5+qgF/QOAVyaliT9vptNpsxNa/HQq4mrq+avJ5fXv9yez06tReDKmjcXs9ExGVeMV0tiuZ0eno+Phuf2O/BlM4pb+hj7vV1knXnwz4PPP//da//utcld8SSiHmY+dqutN+7WFj0IVif4zcavLokUoVEfNjBVUgkYo9Pn/DbpTuZ7Xb4+I8SJMK0+zBYU8kQXOIvf0AwaMoSPRdxDAViMlPNMLCjc0TYNfHbD9fvHP3ZRioPBqm4P1B69YpvG7K7oMWqgP82jnLtLubDrJ9g+8o3t2/2dvBAybZGA9/vdrv/ACOO4HQ=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read organisation</h1>

<MethodEndpoint method={"get"} path={"/v4/onboard/platform/organisation"}></MethodEndpoint>



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.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The organisation.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The organisation ID.","example":"6ae2bf741c3dadfeb27982ec"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the organisation. It is unique in the installation.","example":"Acme Bank"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A short description of the organisation, at most 500 characters.","example":"Retail bank that issues and verifies payment credentials."}}></SchemaItem><SchemaItem collapsible={false} name={"sector"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the organisation type (sector) of the organisation.","example":"Banking"}}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The location of the organisation.","example":"Stockholm, Sweden"}}></SchemaItem><SchemaItem collapsible={false} name={"policyUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the privacy policy of the organisation.","example":"https://acme-bank.example.com/privacy"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the cover image. For an uploaded image it is `<API base URL>/v4/onboard/platform/image/{coverImageId}/web`, which needs no authentication. Empty when the organisation has no cover image.","example":"https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ed/web"}}></SchemaItem><SchemaItem collapsible={false} name={"coverImageId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the cover image. Empty when the organisation has no cover image.","example":"6ae2bf741c3dadfeb27982ed"}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the logo image. For an uploaded image it is `<API base URL>/v4/onboard/platform/image/{logoImageId}/web`, which needs no authentication. Empty when the organisation has no logo image.","example":"https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ee/web"}}></SchemaItem><SchemaItem collapsible={false} name={"logoImageId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the logo image. Empty when the organisation has no logo image.","example":"6ae2bf741c3dadfeb27982ee"}}></SchemaItem><SchemaItem collapsible={false} name={"eulaUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URL of the end-user licence agreement of the organisation. Often empty.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the organisation is enabled.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>authentication</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The login methods of the admins of the organisation.

</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>password</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the admins can log in with a password.","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>oidcPasswordless</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"enabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the admins can log in with a wallet (passwordless login).","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"loginPresentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the presentation definition of the wallet login. Empty when it is not set.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"linkingPresentationDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the presentation definition that links a wallet to an admin. Empty when it is not set.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"authenticatorCredentialDefinitionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the credential definition of the iGrant.io Authenticator credential. Empty when it is not set.","example":""}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>privacyDashboard</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The deployment of the privacy dashboard of the organisation.

</div><SchemaItem collapsible={false} name={"hostname"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The host name of the privacy dashboard. Empty when it is not deployed.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of the privacy dashboard. Empty when it is not deployed.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** [`0`, `1`, `2`]"} schema={{"type":"integer","enum":[0,1,2],"description":"The deployment status: `0` not configured, `1` requested, `2` deployed.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"delete"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether a delete of the privacy dashboard is requested.","example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>buttonLabels</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"dataUsingServicesButtonLabel"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The label of the button that shows the data using services. Empty for the default label.","example":""}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>openIdDeployment</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The deployment of the organisation wallet. For the service endpoints of the wallet, see [Read digital wallet deployment](/docs/openid4vc-api/config-read-digital-wallet-open-id).

</div><SchemaItem collapsible={false} name={"openIdDigitalWalletId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation wallet. Empty when the wallet is not deployed.","example":"5961c261-f35f-4d21-9fd4-79d9f550ba33"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"integer"} qualifierMessage={"**Possible values:** [`0`, `1`, `2`]"} schema={{"type":"integer","enum":[0,1,2],"description":"The deployment status: `0` not configured, `1` requested, `2` deployed.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"ledgerId"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Not in use (`0`).","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"infrastructureProvider"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The provider that runs the wallet, `iGrant.io` for a deployed wallet.","example":"iGrant.io"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of the deployment.","example":"1.0.0"}}></SchemaItem><SchemaItem collapsible={false} name={"role"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Not in use. Usually empty.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"trustAnchor"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Not in use. Usually empty.","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"isWalletProvider"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the organisation is the wallet provider of the installation.","example":false}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>configuredFeatures</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

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.

</div><SchemaItem collapsible={false} name={"gettingStarted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The Getting Started page of the dashboard. No route depends on it.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"dataAgreements"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The data agreements and the global data policies. It gates the create, update and delete of a data agreement or a policy, and the read of one data agreement with its data attributes and revisions (`/v4/config/consent/data-agreement/...`). The lists, the reads of a policy and the service routes do not depend on it.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"dataDisclosureAgreements"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The data disclosure agreements and the data space (`/v4/config/consent/data-disclosure-agreement...`, `/v4/config/consent/data-space/...` and their service routes).","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"managedData"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The Personal Data page of the dashboard. No route depends on it.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"issuerVerifier"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The issuer and verifier routes (`/v4/config/ows/issuer/...`, `/v4/config/ows/verifier/...`) and the extensions (`/v4/config/platform/extension...`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"walletUnit"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The holder routes of the organisation wallet (`/v4/config/ows/holder/...`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"consentManagement"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The individuals, the identity providers and the push notification configuration of the organisation, and the requests of individuals.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"privacyDashboard"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The privacy dashboard routes (`/v4/config/platform/privacy-dashboard...`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The team of the organisation, the data verifier users and the API keys.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"actionLogs"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The activity logs (`GET /v4/audit/platform/admin/logs`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"webhooks"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The webhooks, their event types and their deliveries (`/v4/config/platform/webhook...`).","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"files"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"No route depends on it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"sandbox"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"No route depends on it.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"apiKeyScopesUi"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"A preview of the dashboard: when `true`, the dashboard shows the scope picker of the API keys. No route depends on it.","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"subscribeMethod"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The same value as `subs.method`.","example":0}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>subs</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The subscription settings of the individuals of the organisation. No route of the API sets them.

</div><SchemaItem collapsible={false} name={"method"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":""}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"organisation\": {\n    \"id\": \"6ae2bf741c3dadfeb27982ec\",\n    \"name\": \"Acme Bank\",\n    \"description\": \"Retail bank that issues and verifies payment credentials.\",\n    \"sector\": \"Banking\",\n    \"location\": \"Stockholm, Sweden\",\n    \"policyUrl\": \"https://acme-bank.example.com/privacy\",\n    \"coverImageUrl\": \"https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ed/web\",\n    \"coverImageId\": \"6ae2bf741c3dadfeb27982ed\",\n    \"logoImageUrl\": \"https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ee/web\",\n    \"logoImageId\": \"6ae2bf741c3dadfeb27982ee\",\n    \"eulaUrl\": \"\",\n    \"enabled\": true,\n    \"authentication\": {\n      \"password\": {\n        \"enabled\": true\n      },\n      \"oidcPasswordless\": {\n        \"enabled\": false,\n        \"loginPresentationDefinitionId\": \"\",\n        \"linkingPresentationDefinitionId\": \"\",\n        \"authenticatorCredentialDefinitionId\": \"\"\n      }\n    },\n    \"privacyDashboard\": {\n      \"hostname\": \"\",\n      \"version\": \"\",\n      \"status\": 0,\n      \"delete\": false,\n      \"buttonLabels\": {\n        \"dataUsingServicesButtonLabel\": \"\"\n      }\n    },\n    \"openIdDeployment\": {\n      \"openIdDigitalWalletId\": \"5961c261-f35f-4d21-9fd4-79d9f550ba33\",\n      \"status\": 2,\n      \"ledgerId\": 0,\n      \"infrastructureProvider\": \"iGrant.io\",\n      \"version\": \"1.0.0\",\n      \"role\": \"\",\n      \"trustAnchor\": \"\",\n      \"isWalletProvider\": false\n    },\n    \"configuredFeatures\": {\n      \"gettingStarted\": true,\n      \"dataAgreements\": true,\n      \"dataDisclosureAgreements\": false,\n      \"managedData\": true,\n      \"issuerVerifier\": true,\n      \"walletUnit\": true,\n      \"consentManagement\": true,\n      \"privacyDashboard\": true,\n      \"account\": true,\n      \"actionLogs\": true,\n      \"webhooks\": true,\n      \"files\": false,\n      \"sandbox\": false,\n      \"apiKeyScopesUi\": true\n    },\n    \"subscribeMethod\": 0,\n    \"subs\": {\n      \"method\": 0,\n      \"key\": \"\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"organisation\": {\n    \"id\": \"6ae2bf741c3dadfeb27982ec\",\n    \"name\": \"Acme Bank\",\n    \"description\": \"Retail bank that issues and verifies payment credentials.\",\n    \"sector\": \"Banking\",\n    \"location\": \"Stockholm, Sweden\",\n    \"policyUrl\": \"https://acme-bank.example.com/privacy\",\n    \"coverImageUrl\": \"https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ed/web\",\n    \"coverImageId\": \"6ae2bf741c3dadfeb27982ed\",\n    \"logoImageUrl\": \"https://demo-api.igrant.io/v4/onboard/platform/image/6ae2bf741c3dadfeb27982ee/web\",\n    \"logoImageId\": \"6ae2bf741c3dadfeb27982ee\",\n    \"eulaUrl\": \"\",\n    \"enabled\": true,\n    \"authentication\": {\n      \"password\": {\n        \"enabled\": true\n      },\n      \"oidcPasswordless\": {\n        \"enabled\": false,\n        \"loginPresentationDefinitionId\": \"\",\n        \"linkingPresentationDefinitionId\": \"\",\n        \"authenticatorCredentialDefinitionId\": \"\"\n      }\n    },\n    \"privacyDashboard\": {\n      \"hostname\": \"\",\n      \"version\": \"\",\n      \"status\": 0,\n      \"delete\": false,\n      \"buttonLabels\": {\n        \"dataUsingServicesButtonLabel\": \"\"\n      }\n    },\n    \"openIdDeployment\": {\n      \"openIdDigitalWalletId\": \"5961c261-f35f-4d21-9fd4-79d9f550ba33\",\n      \"status\": 2,\n      \"ledgerId\": 0,\n      \"infrastructureProvider\": \"iGrant.io\",\n      \"version\": \"1.0.0\",\n      \"role\": \"\",\n      \"trustAnchor\": \"\",\n      \"isWalletProvider\": false\n    },\n    \"configuredFeatures\": {\n      \"gettingStarted\": true,\n      \"dataAgreements\": true,\n      \"dataDisclosureAgreements\": false,\n      \"managedData\": true,\n      \"issuerVerifier\": true,\n      \"walletUnit\": true,\n      \"consentManagement\": true,\n      \"privacyDashboard\": true,\n      \"account\": true,\n      \"actionLogs\": true,\n      \"webhooks\": true,\n      \"files\": false,\n      \"sandbox\": false,\n      \"apiKeyScopesUi\": true\n    },\n    \"subscribeMethod\": 0,\n    \"subs\": {\n      \"method\": 0,\n      \"key\": \"\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The `Authorization` header is missing, or the API key or token is not valid.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The API key or token does not allow this call. An API key without the scope of the operation gets the older body `{"Code", "Message"}`. An `X-SandboxOrgId` header that names another sandbox organisation than the one of the API key gets `{"errorCode", "errorDescription"}`. When a platform admin has turned off the feature of the operation for the organisation, the answer has `errorKey` `feature_disabled` and the member `feature` (the name of the feature).

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></TabItem><TabItem label={"Older error body"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"Code"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The HTTP status.","example":403}}></SchemaItem><SchemaItem collapsible={false} name={"Message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What went wrong.","example":"Unauthorized access;User doesn't have enough permissions;"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"Code\": 403,\n  \"Message\": \"Unauthorized access;User doesn't have enough permissions;\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

The organisation cannot be read: `Failed to get organization by ID :<organisationId>`.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>