Skip to main content
Version: 2024.3.1

iGrant.io API documentation

iGrant.io (™) is a Swedish data exchange and verification service provider. It uses self-sovereign identity, verifiable credentials, a digital wallet and solid pod technologies, enabling a new level of interoperability and automating compliance with data regulations in a fully auditable manner.

Authentication​

API key authentication. The value of the Authorization header must be prefixed with ApiKey (note the trailing space), e.g. Authorization: ApiKey <your-api-key>. An API key is an opaque value that starts with owsk_. A key in the older JWT form (it starts with eyJ) no longer works: it gets 401, the same answer as an unknown key. To replace a key, create a new key in the dashboard under Account > Developer APIs > Create API Key (for a key of a sandbox organisation, select the sandbox organisation first), use the new key, then delete the old key. An API key works only in the organisation or the sandbox organisation that it is bound to, so send no X-SandboxOrgId header with it: a request with an API key and an X-SandboxOrgId header that is not the sandbox organisation of the key gets 403.

An API key that is bound to a sandbox organisation acts in that sandbox organisation on every route, also on the data agreement, policy, verification and individual routes. The data agreement, policy and verification routes read the records of the organisation of the key and do not filter them by sandbox organisation; the wallet of the sandbox organisation answers the wallet calls that these routes make. The individual routes act on the individuals of the organisation of the key. An API key that is bound to no sandbox organisation acts on the main organisation.

While a platform admin has suspended your organisation (also after its deletion started), each call with an API key of the organisation gets 401 with errorKey organisation_suspended. The routes of the individuals (/v4/service/consent/individual..., /v4/service/consent/individuals) need the product feature consentManagement of your organisation: when it is off, they get 403 with errorKey feature_disabled and the member feature. An installation can run without the consent service or without the wallet: each route of a service that is not installed gets 404 with errorKey service_not_installed and the member service (consent or wallet), before the check of the key.

Security Scheme Type:apiKey
Header parameter name:Authorization

License

Apache 2.0