nChain Identity
Back to All
  • nChain Identity user documentation
  • ๐Ÿ“‘INTRODUCTION
    • Introduction to nChain Identity
    • Why choose nChain Identity?
      • DiD differentiators
    • How does nChain Identity work?
      • Data flows
      • Use cases and applications
    • Standards and regulations
  • ๐Ÿ“„nChain Identity Issuers
    • What is an issuer?
    • How to become an issuer?
    • Operating an issuer
    • What do issuers do?
    • Issuer API
      • Overview
      • Getting Started
      • Examples
        • Issue an email credential
        • Revoke a claimed email credential
      • API Documentation
        • Credential Offers
        • Agent
        • Claims
  • ๐Ÿ“‘NCHAIN IDENTITY VERIFIER
    • What is a Verifier?
    • Operating a verifier
    • How to become a verifier?
    • Verifier API
      • Overview
      • Getting Started
      • Examples
        • Verify an email credential
      • API Documentation
        • Verifiable Presentation
        • Verifying
        • Agent
        • SIOP
        • Templates
  • ๐Ÿ“„NCHAIN IDENTITY WALLET
    • What is the wallet for?
    • How to receive a Verifiable Credential?
    • How to share a Verifiable Credential?
  • ๐Ÿ“‘Privacy and Security
    • Privacy and Security Measures: NChain Identity Services
    • Revocation and data deletion
  • ๐Ÿ—ƒ๏ธSELF-SOVEREIGN IDENTITY KNOWLEDGE
    • Self-Sovereign Identity
    • Actors
    • Decentralized vs Self-Sovereign Identity
    • Key Principles of Self-Sovereign Identity
    • Self-Sovereign Identity โ€“ Use Cases
    • Digital Trust
    • Some of the critical components of Self Sovereign Identity
      • Trust over IP
    • Some of the critical components of Decentralise ID
      • A Blockchain Tailored for Decentralized Identity
      • Decentralise Identifiers (DiD)
      • Verifiable Credentials
      • Verifiable Presentations
  • ๐Ÿ“‘GLOSSARY
    • Glossary
  • ๐Ÿ“„FAQs / HELP
    • Help & FAQs
      • What is a digital identity?
      • What is nChain Identity, and how does it work?
      • How is blockchain used in nChain Identity?
      • Compatible Blockchains for nChain Identity.
      • How can my business sign up for nChain Identity?
      • How is nChain Identity different to other identity solutions in the market?
      • Can nChain Identity communicate with other identity solutions?
      • What is nChain Identity doing with my data, and does it act as a data processor or controller?
      • What measures does nChain Identity take to protect user data?
      • What support is available for nChain Identity?
      • Can nChain Identity be integrated into our existing systems?
      • How can I get started with nChain Identity?
      • What countries is nChain Identity available in?
Powered by GitBook
On this page
  1. NCHAIN IDENTITY VERIFIER
  2. Verifier API
  3. API Documentation

Verifiable Presentation

OpenAPI documentation for the "Verifiable Presentation" module

PreviousAPI DocumentationNextVerifying

Last updated 5 months ago

๐Ÿ“‘

Get verifiable presentations

get

Retrieve a paginated response of verifiable presentationsClaim-based access control: Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
Query parameters
pagenumberOptional

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

limitnumberOptional

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[]Optional

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

filter.definitionIdstring[]Optional

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

filter.createdBystring[]Optional

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

filter.modifiedBystring[]Optional

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

filter.createdAtstring[]Optional

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

filter.updatedAtstring[]Optional

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

filter.deletedAtstring[]Optional

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

filter.verifiedAtstring[]Optional

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

filter.statusstring[]Optional

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

filter.searchstring[]Optional

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

Responses
200Success
application/json
Responseall of
and
400
Invalid request parameters
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
get
GET /private/verifiable-presentations HTTP/1.1
Host: ..
Authorization: Bearer JWT
Accept: */*
{
  "data": [
    {
      "correlationId": "f9dbff8e-6dba-4955-bd7f-61c083db290d",
      "definitionId": "emailCredential",
      "organisationDID": "text",
      "status": "created",
      "content": [
        {
          "id": "text",
          "createdAt": "2025-05-12T20:47:34.358Z",
          "types": [
            "text"
          ],
          "credentialSubject": {},
          "expirationDate": "2025-05-12T20:47:34.358Z",
          "issuanceDate": "2025-05-12T20:47:34.358Z",
          "issuer": "text",
          "subject": "text"
        }
      ],
      "modifiedBy": "text",
      "createdBy": "text",
      "createdAt": "2025-05-12T20:47:34.358Z",
      "updatedAt": "2025-05-12T20:47:34.358Z",
      "verifiedAt": "2025-05-12T20:47:34.358Z"
    }
  ],
  "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"
  }
}