Read digital wallet deployment
Returns the deployment of the organisation wallet: its status, whether the organisation is the wallet provider, and the service URLs that issuers, holder wallets and verifiers use (the credential issuer metadata, the authorization server metadata, the notification endpoint and the JWKS).
The answer is 200 also without a deployment: then status is 0, statusStr is Not Configured, and the URLs and version are empty strings. Check status before you use the URLs. Deploy the wallet with Deploy digital wallet.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
wallet:read
Response
The deployment of the organisation wallet.
agentService Endpoint stringThe base URL of the OpenID4VCI and OpenID4VP service routes of the organisation wallet. Empty without a deployment.
Example:
"https://demo-api.igrant.io/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service"credentialOffer Endpoint stringThe credential offer endpoint of the organisation wallet as a holder (OpenID4VCI 1.0 section 4.1). Empty without a deployment.
Example:
"https://demo-api.igrant.io/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service/credential-offer"versionstringThe version of the deployment. Empty without a deployment.
Example:
"1.0.0"statusenum<integer>The deployment status:
0(Not Configured) or2(Deployed).Available options:
0,2Example:
2statusStr enum<string>The deployment status as text.
Available options:
Not Configured,DeployedExample:
"Deployed"ledgerName stringA fixed text that the service sends for compatibility, also without a deployment.
Example:
"European Blockchain Services Infrastructure"ledgerURL stringA fixed URL that the service sends for compatibility, also without a deployment.
Example:
"https://hub.ebsi.eu/"ledgerID integerAlways
0.Example:
0infrastructureProvider stringThe provider that hosts the wallet. Always
iGrant.io.Example:
"iGrant.io"deploymentRegion stringThe region of the deployment, also sent without a deployment.
Example:
"Europe: Frankfurt"isWallet Provider booleantrue: the organisation is the platform operator, its wallet is the wallet provider of the installation, and the wallet provider operations work for it. The wallet gets it at its deployment; no operation changes it.Example:
falsecredentialIssuer Metadata stringThe URL of the credential issuer metadata of the organisation (OpenID4VCI 1.0), for the protocol version
version-01. Empty without a deployment.Example:
"https://demo-api.igrant.io/.well-known/openid-credential-issuer/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service/version-01"authorizationServer Metadata stringThe URL of the OAuth 2.0 authorization server metadata of the organisation (RFC 8414), for
version-01. Empty without a deployment.Example:
"https://demo-api.igrant.io/.well-known/oauth-authorization-server/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service/version-01"notificationEndpoint stringThe URL of the notification endpoint of the issuer (OpenID4VCI 1.0). Empty without a deployment.
Example:
"https://demo-api.igrant.io/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service/version-01/notification"jwksEndpoint stringThe URL of the JSON Web Key Set of the organisation. Empty without a deployment.
Example:
"https://demo-api.igrant.io/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service/version-01/jwks"