Skip to main content

List credential definition

GET 
/v2/config/digital-wallet/openid/sdjwt/credential-definitions

Lists all credential definitions configured for OID4VCI credential issuance, with the newest change first. Each entry also holds the issuance counts of the credential definition, and the response holds the aggregate issuance counts of the organisation. search matches the label and the credential definition ID. sortOrder sorts on the last modification time. vct, doctype and type match the value at the top level of a record and in its credential configurations.

Request​

Query Parameters

    offset integerrequired

    Default value: 0

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    limit integerrequired

    Default value: 10

    Maximum number of records to return per page.

    vct string

    Filter by IETF SD-JWT VC verifiable credential type identifier.

    doctype string

    Filter by ISO 18013-5 mDoc/mDL document type identifier.

    type string

    Filter by W3C Verifiable Credential type (JWT format).

    search stringrequired

    Search term to filter results by

    sortOrder stringrequired

    Possible values: [desc, asc]

    Default value: desc

    Sort order for the returned records (ascending or descending).

    skipCounts booleanrequired

    Default value: false

    When true, the server does not calculate the issuance counts. Use this option for a faster response. The server then returns zero in totalCountOfCredentialHistory and in each issuanceBreakdown field.

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​

Credential definitions listed successfully

Response Headers
    Schema
      credentialDefinition object[]

      Credential definitions for the current page, sorted by the last modification time. The value is null or an empty array when the page holds no record.

      pagination object
      currentPage integer

      Current page number

      totalItems integer

      Total number of items available

      totalPages integer

      Total number of pages based on limit

      limit integer

      Number of items per page

      hasPrevious boolean

      Indicates if there's a previous page

      hasNext boolean

      Indicates if there's a next page

      issuanceHistoryStats object

      Aggregate issuance counts for the whole organisation. The filters and the pagination do not change these counts.

      total integer

      Total number of credential exchange records.

      accepted integer

      Number of records that the holder accepted and that are not revoked.

      inProgress integer

      Number of records that are still in progress.

      revoked integer

      Number of records whose credential is revoked.

      denied integer

      Number of records for which the issuer denied the issuance.

    Loading...
    Last updated on