List credential

GET 
/v2/config/digital-wallet/openid/sdjwt/credentials

This endpoint is used to list credential.

Request

Query Parameters

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

expired booleanrequired

Possible values: [true, false]

Returns expired credentials if value is true else return active credentials

Responses

200

Response Headers

application/json

Schema

Schema

credential object[]
Array [
credentialId stringrequired
Identifier for the credential
credentialToken stringrequired
JSON web token for the verifiable credential received and stored.
credential objectrequired
Decoded payload for JWT of the verifiable credential received and stored.
property name* any
Decoded payload for JWT of the verifiable credential received and stored.
credentialStatus stringrequired
Possible values: [credential_pending, credential_acked]
It support 2 credential statuses: 1. credential_pending: Indicates the credential requires further inputs such as a transaction code or is still not ready as the issuance mode is deferred. 2. credential_acked: Indicates the credential has been received and stored by the holder.
acceptanceToken stringrequired
To be used for receiving the credential using deferred credential endpoint.
credentialIssuer stringrequired
Identifier of the credential issuer
userPin stringrequired
Transaction code used for receiving credential using pre-authorized grant.
createdAt numberrequired
Timestamp when the record was created.
updatedAt numberrequired
Timestamp when the record was updated.
userPinRequired booleanrequired
Indicates that a transaction code is necessary for receiving credential using pre-authorized grant.
credentialFormat stringrequired
Format of the credential received. For e.g. jwt_vc or jwt_vc_json or dc+sd-jwt
presentationId stringrequired
Identifier for the presentation
issuer objectrequired
name string
location string
cover string
logo string
description string
credentialConfigurations object
transactionCode object
inputMode string
Possible values: [numeric, text]
inputLength integer
description string
authorizationDetails object[]
Array [
type string
credential_configuration_id string
format string
]
revocationStatus string
Possible values: [Operational, Revoked, Suspended]
Specifies the revocation status for verifiable credential.
legalPidAttestation string
Specifies the legal pid attestation verifiable credential of the issuer.
legalPidAttestationPop string
Specifies the legal pid attestation proof of pocession credential of the issuer.
legalPidVerified boolean
Specifies whether legal pid attestation credential of issuer is verified.
autoPresent boolean
Boolean value indicates whether the credential should be auto presented.
version string
Possible values: [draft_14, draft_18]
Specifies the version of oid4vp draft specification
kid string
Specifies the key identifier of keys to be used for credential issuance
trustAnchor string
Possible values: [jwk, did:key, did:ebsi, did:web]
Specifies the trust anchor used for credential issuance
expiredCredentialTokens string[]
Contains expired credential tokens
expiredCredentials object[]
Contains expired credentials decoded objects
]
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

Example (from schema)

{
  "credential": [
    {
      "credentialId": "string",
      "credentialToken": "string",
      "credential": {},
      "credentialStatus": "credential_pending",
      "acceptanceToken": "string",
      "credentialIssuer": "string",
      "userPin": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "userPinRequired": true,
      "credentialFormat": "string",
      "presentationId": "string",
      "issuer": {
        "name": "string",
        "location": "string",
        "cover": "string",
        "logo": "string",
        "description": "string"
      },
      "credentialConfigurations": {},
      "transactionCode": {
        "inputMode": "numeric",
        "inputLength": 0,
        "description": "string"
      },
      "authorizationDetails": [
        {
          "type": "openid_credential",
          "credential_configuration_id": "string",
          "format": "string"
        }
      ],
      "revocationStatus": "Operational",
      "legalPidAttestation": "string",
      "legalPidAttestationPop": "string",
      "legalPidVerified": true,
      "autoPresent": true,
      "version": "draft_14",
      "kid": "string",
      "trustAnchor": "jwk",
      "expiredCredentialTokens": [
        "string"
      ],
      "expiredCredentials": [
        {}
      ]
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

Loading...