Skip to main content

Deploy digital wallet

POST 
/v2/config/digital-wallet/openid

Deploys the OID4VC digital wallet for the organisation. The service registers the organisation with the OpenID wallet backend and returns the endpoints of the new deployment. Call this operation once, before you create a global configuration, a credential definition or a presentation definition.

The organisation must have no deployment yet. If a deployment exists or a deployment request is open, the service answers with HTTP 400. There is no operation that removes a deployment, so you cannot deploy the wallet a second time.

Request​

Body

Optional seed for the key material of the wallet. Send an empty body to let the service make the deployment without a seed.

    cryptographicSeed string

    Seed that the service uses for the key material of the wallet. This field is optional. The service uses the value only when it holds one character or more, and it sends no seed when you give an empty value or leave the field out. Treat this value as a secret: keep it out of logs and out of version control.

Responses​

The service deployed the OpenID digital wallet and returned the deployment details.

Response Headers
    Schema
      agentServiceEndpoint stringrequired

      Base URL of the OID4VCI and OpenID4VP service of the organisation.

      credentialOfferEndpoint stringrequired

      URL of the OID4VCI Credential Offer endpoint.

      version stringrequired

      Software version of the deployed agent.

      status integerrequired

      Possible values: [2]

      Deployment status of the agent. A successful deploy always sets the status to Deployed, so this operation always gives 2.

      statusStr stringrequired

      Possible values: [Deployed]

      Deployment status of the agent as text. This operation always gives Deployed.

      ledgerName stringrequired

      Name of the distributed ledger that the agent uses for DID registration.

      ledgerURL stringrequired

      URL of the distributed ledger.

      ledgerID integerrequired

      Identifier of the ledger network. The service does not set this field and always returns 0.

      infrastructureProvider stringrequired

      Infrastructure provider that hosts the agent.

      deploymentRegion stringrequired

      Geographic region of the agent deployment.

      isWalletProvider booleanrequired

      When true, the organisation is a wallet provider and can issue Wallet Unit Attestations. A new deployment always returns false. Use the update operation on this path to enable the capability.

    Loading...
    Last updated on