Skip to main content

Read Qualified Trust Service Provider (QTSP) credential

GET 
/v2/config/digital-wallet/openid/key-management/qtsp/:credentialId

Reads the details of 1 Qualified Trust Service Provider (QTSP) signing credential. The wallet reads the details from the QTSP through the Cloud Signature Consortium (CSC) API. Configure and enable the QTSP vault before you call this operation.

The QTSP controls the members of the credentialInfo object, so the members can change between providers.

You cannot read a credential whose ID is the literal string credentials. That path goes to the list QTSP credentials operation.

Request​

Path Parameters

    credentialId stringrequired

    ID of the QTSP signing credential. Use the list QTSP credentials operation to get the available IDs.

    Example: <qtsp-credential-id>

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​

QTSP credential read successfully.

Response Headers
    Schema
      credentialInfo objectnullablerequired

      The credentials/info response of the Qualified Trust Service Provider (QTSP). The wallet sends the response of the QTSP without a change, so the QTSP controls the members of this object. The members below are the usual members of a Cloud Signature Consortium (CSC) response. The value is null when the QTSP sends no information.

      OTP object
      presence string

      Tells you if the QTSP needs a one time password.

      property name* any
      PIN object
      format string

      Format of the PIN.

      presence string

      Tells you if the QTSP needs a PIN.

      property name* any
      authMode string

      Authentication mode of the credential.

      cert object
      certificates string[]

      Certificate chain of the credential, in base64 format.

      issuerDN string

      Distinguished name of the certificate issuer.

      serialNumber string

      Serial number of the certificate.

      status string

      Status of the certificate.

      subjectDN string

      Distinguished name of the certificate subject.

      validFrom string

      Start of the certificate validity period.

      validTo string

      End of the certificate validity period.

      property name* any
      description string

      Description of the credential.

      key object
      algo string[]

      Signature algorithms that the key supports.

      curve string

      Elliptic curve of the key.

      len integer

      Length of the key, in bits.

      status string

      Status of the key.

      property name* any
      multisign integer

      Number of signatures that the credential can make in 1 operation.

      property name* anynullable

      The credentials/info response of the Qualified Trust Service Provider (QTSP). The wallet sends the response of the QTSP without a change, so the QTSP controls the members of this object. The members below are the usual members of a Cloud Signature Consortium (CSC) response. The value is null when the QTSP sends no information.

    Loading...
    Last updated on