Skip to main content
Deployment

Read digital wallet deployment

GET/v4/config/ows/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

  • Authorizationstringheaderrequired

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

    Scope:wallet:read

Response

application/json

The deployment of the organisation wallet.

  • agentServiceEndpointstring

    The 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"

  • credentialOfferEndpointstring

    The 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"

  • versionstring

    The version of the deployment. Empty without a deployment.

    Example:"1.0.0"

  • statusenum<integer>

    The deployment status: 0 (Not Configured) or 2 (Deployed).

    Available options:0,2

    Example:2

  • statusStrenum<string>

    The deployment status as text.

    Available options:Not Configured,Deployed

    Example:"Deployed"

  • ledgerNamestring

    A fixed text that the service sends for compatibility, also without a deployment.

    Example:"European Blockchain Services Infrastructure"

  • ledgerURLstring

    A fixed URL that the service sends for compatibility, also without a deployment.

    Example:"https://hub.ebsi.eu/"

  • ledgerIDinteger

    Always 0.

    Example:0

  • infrastructureProviderstring

    The provider that hosts the wallet. Always iGrant.io.

    Example:"iGrant.io"

  • deploymentRegionstring

    The region of the deployment, also sent without a deployment.

    Example:"Europe: Frankfurt"

  • isWalletProviderboolean

    true: 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:false

  • credentialIssuerMetadatastring

    The 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"

  • authorizationServerMetadatastring

    The 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"

  • notificationEndpointstring

    The 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"

  • jwksEndpointstring

    The 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"