iGrant.io API documentation
The iGrant.io API for the organisation wallet: issue credentials with OpenID4VCI 1.0, verify them with OpenID4VP 1.0, hold credentials in the wallet of your organisation, and act as a wallet provider. It supports IETF SD-JWT VC, ISO/IEC 18013-5 mdoc (mDL) and W3C VC (JWT) credentials, the EUDI Wallet and European Business Wallet profiles, and the Digital Credentials API.
Authentication
- API Key: ApiKey
- HTTP: Bearer Auth
Send the API key in the Authorization header with the prefix ApiKey (with a space): Authorization: ApiKey <api-key>. Create a key in the dashboard under Account > Developer APIs. A key starts with owsk_; a key in the older JWT form (eyJ...) gets 401. Each operation names the scope that the key needs: a key without it gets 403. A key with one of the older scopes config or onboard can call every route under /v4/config or /v4/onboard. A key works only in the organisation or sandbox organisation that it is bound to: do not send X-SandboxOrgId with it (another sandbox organisation gets 403). To replace a key, create a new one, use it, then delete the old one. While a platform admin has suspended the organisation (also after its deletion started), every call with its key gets 401 with errorKey organisation_suspended. The wallet operations (/v4/config/ows) of a sandbox organisation that was deleted answer 410 with organisation_deactivated. 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 |
The access token of an admin login, in the Authorization header with the prefix Bearer : Authorization: Bearer <access-token>. The dashboard uses it. The operations of the platform admins take only this token: no API key can call them.
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
| Bearer format: | JWT |