Read wallet unit status

GET 
/v2/config/digital-wallet/openid/wallet-unit/status

Reads the wallet unit status from the holder's point of view. The status follows the Wallet Unit Attestation (WUA) lifecycle and the presence of a Legal Person Identification Data (LPID) credential in the wallet.

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

Responses

200

The server returns the wallet unit status.

Response Headers

application/json

Schema

Schema

status string
Possible values: [not_installed, installed, operational, valid]
Wallet unit status:
1. not_installed: The organisation has no wallet deployment.
2. installed: The wallet is deployed, but it holds no valid Wallet Unit Attestation.
3. operational: The wallet holds a valid Wallet Unit Attestation, but no LPID credential.
4. valid: The wallet holds a valid Wallet Unit Attestation and an LPID credential.

Example (from schema)

{
  "status": "operational"
}

400

The server cannot read the wallet unit status for the organisation.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

The organisation is unknown.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...