Verifiable Presentation

OpenAPI documentation for the "Verifiable Presentation" module

Last updated 2 months ago

Get verifiable presentations

Retrieve a paginated response of verifiable presentations<hr />Claim-based access control: <code>Verifier_Admin</code>, <code>Verifier_Auditor</code>, <code>Verifier_User</code>

get

/private/verifiable-presentations

Authorizations

Query parameters

pagenumber

Page number to retrieve.If you provide invalid value the default page number will applied Example: 1 Default Value: 1

limitnumber

Number of records per page. Example: 20 Default Value: 20 Max Value: 100

  If provided value is greater than max value, max value will be applied.

filter.correlationIdstring[]

Filter by correlationId query param. Format: filter.correlationId={$not}:OPERATION:VALUE Example: filter.correlationId=$not:$like:John Doe&filter.correlationId=like:John <h4>Available Operations</h4><ul><li>$eq</li>

<li>$contains</li></ul>

filter.definitionIdstring[]

Filter by definitionId query param. Format: filter.definitionId={$not}:OPERATION:VALUE Example: filter.definitionId=$not:$like:John Doe&filter.definitionId=like:John <h4>Available Operations</h4><ul><li>$eq</li>

<li>$contains</li></ul>

filter.createdBystring[]

Filter by createdBy query param. Format: filter.createdBy={$not}:OPERATION:VALUE Example: filter.createdBy=$not:$like:John Doe&filter.createdBy=like:John <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.modifiedBystring[]

Filter by modifiedBy query param. Format: filter.modifiedBy={$not}:OPERATION:VALUE Example: filter.modifiedBy=$not:$like:John Doe&filter.modifiedBy=like:John <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.createdAtstring[]

Filter by createdAt query param. Format: filter.createdAt={$not}:OPERATION:VALUE Example: filter.createdAt=$not:$like:John Doe&filter.createdAt=like:John <h4>Available Operations</h4><ul><li>$eq</li>

filter.updatedAtstring[]

Filter by updatedAt query param. Format: filter.updatedAt={$not}:OPERATION:VALUE Example: filter.updatedAt=$not:$like:John Doe&filter.updatedAt=like:John <h4>Available Operations</h4><ul><li>$eq</li>

filter.deletedAtstring[]

Filter by deletedAt query param. Format: filter.deletedAt={$not}:OPERATION:VALUE Example: filter.deletedAt=$not:$like:John Doe&filter.deletedAt=like:John <h4>Available Operations</h4><ul><li>$eq</li>

filter.verifiedAtstring[]

Filter by verifiedAt query param. Format: filter.verifiedAt={$not}:OPERATION:VALUE Example: filter.verifiedAt=$not:$like:John Doe&filter.verifiedAt=like:John <h4>Available Operations</h4><ul><li>$eq</li>

filter.statusstring[]

Filter by status query param. Format: filter.status={$not}:OPERATION:VALUE Example: filter.status=$not:$like:John Doe&filter.status=like:John <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.searchstring[]

Filter by search query param. Format: filter.search={$not}:OPERATION:VALUE Example: filter.search=$not:$like:John Doe&filter.search=like:John <h4>Available Operations</h4><ul><li>$fulltext</li></ul>

sortBystring · enum[]

Parameter to sort by. To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting Format: fieldName:DIRECTION Example: sortBy=id:DESC&sortBy=createdAt:ASC Default Value: updatedAt:DESC <h4>Available Fields</h4><ul><li>createdAt</li>

<li>updatedAt</li> <li>verifiedAt</li> <li>status</li></ul>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../private/verifiable-presentations' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

{
  "data": [
    {
      "correlationId": "f9dbff8e-6dba-4955-bd7f-61c083db290d",
      "definitionId": "emailCredential",
      "organisationDID": "text",
      "modifiedBy": "text",
      "createdBy": "text",
      "createdAt": "2025-02-22T22:45:03.960Z",
      "updatedAt": "2025-02-22T22:45:03.960Z",
      "verifiedAt": "2025-02-22T22:45:03.960Z",
      "status": "created",
      "content": [
        {
          "id": "text",
          "createdAt": "2025-02-22T22:45:03.960Z",
          "credentialSubject": {},
          "expirationDate": "2025-02-22T22:45:03.960Z",
          "issuanceDate": "2025-02-22T22:45:03.960Z",
          "issuer": "text",
          "subject": "text",
          "types": [
            "text"
          ]
        }
      ]
    }
  ],
  "meta": {
    "select": [
      "text"
    ],
    "filter": {
      "correlationId": "text",
      "definitionId": "text",
      "createdBy": "text",
      "modifiedBy": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "deletedAt": "text",
      "verifiedAt": "text",
      "status": "text",
      "search": "text"
    }
  },
  "links": {
    "first": "text",
    "previous": "text",
    "current": "text",
    "next": "text",
    "last": "text"
  }
}