List Qualified Trust Service Provider (QTSP) Credentials

GET 
/v2/config/digital-wallet/openid/key-management/qtsp/credentials

Lists the Qualified Trust Service Provider (QTSP) signing credentials that the organisation can use. The wallet reads the list from the QTSP through the Cloud Signature Consortium (CSC) API. Configure and enable the QTSP vault before you call this operation.

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

QTSP credentials listed successfully.

Response Headers

application/json

Schema

Schema

credentials string[]nullablerequired

IDs of the QTSP signing credentials. Use 1 of these IDs in the configure QTSP credential operation. The value is null when the QTSP holds no credential for the organisation.

Example (from schema)

{
  "credentials": [
    "<qtsp-credential-id>"
  ]
}

400

The QTSP vault is not configured, or the QTSP refused the request.

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

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

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

Loading...