Skip to main content
Deployment

Deploy digital wallet

POST/v4/config/ows/wallet/deployment

Deploys the organisation wallet of the organisation. Call it once, before any other OpenID4VC operation of the organisation. The API creates the wallet organisation with its wallet key (an automatic key in the local key store local-openbao, which is not a signing key: the key API does not show it while it has no certificate chain), its holder identity, and its issuer, verifier and holder configurations with their default values. When the installation has a wallet provider, the wallet provider also registers an organisation wallet unit for the new wallet, not authorised.

The wallet of the platform operator organisation of the installation becomes the wallet provider at this deployment (isWalletProvider: true) and also gets the two wallet provider configurations, without a signing key. No operation turns the wallet provider capability on or off later.

The organisation must have no deployment yet: a second deploy is refused, and no operation removes a deployment. Read the deployment and its service URLs later with Read digital wallet deployment.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:wallet:create

Body

application/json

A JSON object. Send {} for the default. An empty body or an unknown member gives 400.

  • infrastructureProviderenum<string>

    Optional. The provider that hosts the wallet. Only iGrant.io is accepted.

    Available options:iGrant.io

    Example:"iGrant.io"

Response

application/json

The new deployment.

  • agentServiceEndpointstring

    The base URL of the OpenID4VCI and OpenID4VP service routes of the organisation wallet.

    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): an issuer sends a credential offer for the organisation here.

    Example:"https://demo-api.igrant.io/organisation/9dd765f7-4002-446b-ada4-d16dab77c866/service/credential-offer"

  • versionstring

    The version of the deployment.

    Example:"1.0.0"

  • statusenum<integer>

    The deployment status. Always 2 (Deployed).

    Available options:2

    Example:2

  • statusStrenum<string>

    The deployment status as text. Always Deployed.

    Available options:Deployed

    Example:"Deployed"

  • ledgerNamestring

    A fixed text that the service sends for compatibility.

    Example:"European Blockchain Services Infrastructure"

  • ledgerURLstring

    A fixed URL that the service sends for compatibility.

    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.

    Example:"Europe: Frankfurt"

  • isWalletProviderboolean

    true when the organisation is the platform operator of the installation: its wallet is the wallet provider. false for every other organisation. No operation changes it later.

    Example:false