Skip to main content

Enable wallet provider

PUT 
/v2/config/digital-wallet/openid

Enables the wallet provider capability for the organisation. Send isWalletProvider with the value true. The service then registers the organisation as a wallet provider and the organisation can register wallet units and issue Wallet Unit Attestations. If you send false, the service keeps the current value and returns the deployment details.

Request​

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Body

required

The wallet provider capability to set for the organisation.

    isWalletProvider boolean

    Set to true to enable the wallet provider capability. The service ignores the value false and keeps the current setting.

Responses​

The service returned the OpenID digital wallet 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: [0, 1, 2]

      Deployment status of the agent. 0 is Not Configured. 1 is Requested. 2 is Deployed.

      statusStr stringrequired

      Possible values: [Not Configured, Requested, Deployed]

      Deployment status of the agent as text.

      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.

    Loading...
    Last updated on