v1

latestOpenAPI 3.0.02026-07-17647099.1 KB

Credentials

Get Credentials

Returns a list of credentials for the provided identity. Results are paginated. Filter between all | revoked | expired credentials and also perform a full text search with the query parameter.

get/v2/identities/{identifier}/credentials

Path parameters

identifierstring required

Issuer identifier

Query parameters

pageinteger

Example:1

Page to fetch. First is one. If omitted, all results will be returned.

credentialSubjectstring

Example:did:polygonid:polygon:amoy:2qFpPHotk6oyaX1fcrpQFT4BMnmg8YszUwxYtaoGoe

schemaTypestring

Example:UniquenessCredential

Filter credentials by schema type (partial match)

schemaUrlstring

Example:ipfs://QmYpsAHYPrNNaNc2o9SAMrPknSAYYAbse4hYxQgMP64Tvj

Filter credentials by schema URL (begins with match)

status'all' | 'revoked' | 'expired'

Credential status:

all - All Credentials. (default value)
revoked - Only revoked credentials
expired - Only expired credentials

querystring

Query string to do full text search

max_resultsinteger

Example:50

Number of items to fetch on each page. Minimum is 10. Default is 50. No maximum by the moment.

sortstring[]

The minus sign (-) before createdAt means descending order.

Response

List of credentials

Example response

{
  "items": [
    {
      "proofTypes": [
        "BJJSignature2021"
      ],
      "schemaHash": "c9b2370371b7fa8b3dab2a5ba81b6838",
      "encryptedVC": {
        "context": "https://www.w3.org/2018/credentials/examples/v1",
        "type": "KYCAgeCredential",
        "expirationDate": "2023-10-26T10:59:08Z",
        "issuanceDate": "2023-10-26T10:59:08Z"
      }
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "max_results": 50
  }
}