Skip to main content

Read digital wallet deployment

GET 
/v2/config/digital-wallet/openid

Reads the OID4VC digital wallet deployment of the organisation. The response gives the deployment status, the service endpoints, and the well-known metadata URLs that wallets and verifiers use.

The service answers with HTTP 200 even when the organisation has no deployment. In that case status is 0, statusStr is Not Configured, secureVaults is null, and every endpoint and metadata URL is an empty string. Read status before you use the URLs.

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. The value is an empty string when the organisation has no deployment.

      credentialOfferEndpoint stringrequired

      URL of the OID4VCI Credential Offer endpoint.

      version stringrequired

      Software version of the deployed agent.

      status integerrequired

      Possible values: [0, 2]

      Deployment status of the agent. This operation gives 0 (Not Configured) or 2 (Deployed) only. It reports every status other than Deployed as 0, so it never gives 1 (Requested).

      statusStr stringrequired

      Possible values: [Not Configured, Deployed]

      Deployment status of the agent as text. This operation gives Not Configured or Deployed only, for the same reason as status.

      ledgerName stringrequired

      Name of the distributed ledger that the agent uses for DID registration. The service returns this constant value also when the organisation has no deployment.

      ledgerURL stringrequired

      URL of the distributed ledger. The service returns this constant value also when the organisation has no deployment.

      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. The service returns iGrant.io also when the organisation has no deployment.

      deploymentRegion stringrequired

      Geographic region of the agent deployment. The service returns this constant value also when the organisation has no deployment.

      isWalletProvider booleanrequired

      When true, the organisation is a wallet provider and can issue Wallet Unit Attestations.

      secureVaults integer[]nullablerequired

      Possible values: [0, 1, 2, 3, 4]

      Key management backends that the organisation configured. The value is null when the organisation configured none.

      credentialIssuerMetadata stringrequired

      URL of the OID4VCI Credential Issuer Metadata document. The value is an empty string when the organisation has no deployment.

      authorizationServerMetadata stringrequired

      URL of the OAuth 2.0 Authorization Server Metadata document. The value is an empty string when the organisation has no deployment.

      notificationEndpoint stringrequired

      URL of the OID4VCI Notification Endpoint. The value is an empty string when the organisation has no deployment.

      jwksEndpoint stringrequired

      URL of the JSON Web Key Set of the organisation. The value is an empty string when the organisation has no deployment.

    Loading...
    Last updated on