Hypersign.Id
Hypersign.idEntity StudioIdentity Wallet
  • 💬Welcome!
  • Hypersign KYC
    • Introduction
    • Integrations
      • KYC Service
      • Widget Configuration
      • Environments
        • Development
        • Production
      • Webhook
    • KYC Widget
      • Integrations
        • Backend Integration
          • Generate AccessTokens
          • Generate KYC Session Id
        • Frontend Integration
      • Data Capture
        • Data Vault Setup
        • Capture Facial Recognition
        • Capture ID Document
        • Capture zk-proof and KYC token
        • Capture User Consent
      • User Data
        • idToken
    • Hypersign ID Wallet
    • On-Chain KYC
      • Contracts Deployment
      • Use Cases
      • Supported Blockchains
      • KYC Token Metadata
    • Dashboard
      • User Sessions
      • User Session Details
      • Usage
      • Credit
    • Concepts
      • Facial Recognition
      • ID Verification (via OCR)
      • Reusable KYC
      • Encrypted Data Vault (EDV)
      • Facial Authentication
      • Issuer Marketplace
      • Security
      • Privacy
      • Credentials Types
        • Personhood Credential
        • Passport / Govt. ID Credential
      • zk Proof Types
        • Proof Of Personhood (PoP)
        • Proof Of KYC (PoK)
        • Proof Of Age (PoA)
      • Uniqueness Check
      • Credential Revocability
      • Machine Readable Zone (MRZ)
      • Liveliness Check
      • Zero Knowledge Proof (zkp)
        • Introduction
        • zk-SNARK
        • Circuits
        • SSI and ZKP
    • Tutorials
      • How to Integrate KYC in minutes?
      • How to add your team member?
  • Hypersign SSI
    • Introduction
    • Setup SSI Service
      • Create Your First DID
      • Credits
    • 🔗API Reference
      • Service Authentication API
      • DID
      • Schema
      • Verifiable Credential
      • Verifiable Presentation
        • Presentation Template
        • Presentation
    • 🎰API Playground
    • 🏑SSI Playground
  • Hypersign Developer Dashboard
    • Service
      • Managing API keys
      • Network Fee
    • Members & Roles
      • Members
        • Assign Role To Member
      • Invitations
        • Member Access Admin's Dashboard
      • Roles & Permissions
        • Permissions List
    • Security
      • Login
      • Multi factor Authentication (MFA)
  • Hypersign Identity Network
    • Introduction
    • Validators & Delegators
      • Installation of Node
      • Running a Testnet Validator Node
    • Governance
      • Proposals
        • Blockchain Node Upgrade
        • Community Pool Spend Proposal
        • Blockchain Parameter Change Proposal
        • Text Proposal
      • Delegation
    • Faucet (testnet)
    • Developers
      • HID-Node Codebase
      • ⚙️Setup Local hid-network Tutorial
        • Running one-node local hid network
        • Create and fund new account
        • Transfer funds
        • Connect Keplr to local hid network
      • Hypersign SSI Toolkit
        • Hypersign DID SDK
        • Hypersign Schema SDK
        • Hypersign Verifiable Credential SDK
        • Hypersign Verifiable Presentation SDK
        • OfflineSigner
    • Blockchain & ID Explorer
  • Core Concepts
    • Introduction
    • Decentralized Identifier (DID)
      • DID Registry
      • Private and Public DID
      • DID Authentication
      • DID Communication (DIDComm)
      • Adding multiple controller to DID
      • Adding multiple verification methods
      • Verification Method vs Recovery Signature
      • Blockchain Account Id
      • DID Threshold
      • Verifiable Condition
      • Verification Relationships
        • Authorization Capabilities (zCap)
    • Schema
      • Schema Registry
      • Schema.org
    • Verifiable Credential (VC)
      • Credential Revocation Registry
      • Issuing a Credential to Multiple Subjects
      • Bearer Credential
      • Single-Use Credential
    • Verifiable Presentation (VP)
    • Specifications
      • Supported Signature Algorithms
      • Client Specification
        • EVM based chains
        • Cosmos based chains
  • Ecosystem
    • Forum
    • Github
    • HID Explorer
    • Eiko
    • MetaAuth
  • Privacy Policy
Powered by GitBook
On this page
Edit on GitHub
  1. Hypersign SSI
  2. API Reference
  3. Verifiable Presentation

Presentation Template

PreviousVerifiable PresentationNextPresentation

Last updated 2 years ago

Entity Studio SSI API base URL:

🔗
https://api.entity.hypersign.id
get
Authorizations
Path parameters
templateIdstringRequired
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Responses
200
Presentation template detail
application/json
404
Resource not found
application/json
get
GET /api/v1/presentation/template/{templateId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "appId": "43...18-...........",
  "domain": "fyre.hypersign.id",
  "query": [
    {
      "type": "QueryByExample",
      "credentialQuery": [
        {
          "required": true,
          "reason": "We need you to prove your eligibility to work.",
          "example": {
            "@context": [
              "https://www.w3.org/2018/credentials/v1"
            ],
            "type": "AlumniCredential",
            "credentialSubject": {
              "name": "Random name",
              "id": "did:hid:testnet:............................."
            },
            "credentialSchema": {
              "id": "sch:hid:testnet:...............",
              "type": "JsonSchemaValidator2018"
            },
            "trustedIssuer": [
              {
                "required": true,
                "issuer": "did:hid:testnet:................"
              }
            ]
          }
        }
      ]
    }
  ]
}
delete
Authorizations
Path parameters
templateIdstringRequired
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Responses
200
Template Deleted Successfully
application/json
404
No resource found for templateId 63d7c558743fea9d22aab...
application/json
delete
DELETE /api/v1/presentation/template/{templateId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "appId": "43...18-...........",
  "domain": "fyre.hypersign.id",
  "query": [
    {
      "type": "QueryByExample",
      "credentialQuery": [
        {
          "required": true,
          "reason": "We need you to prove your eligibility to work.",
          "example": {
            "@context": [
              "https://www.w3.org/2018/credentials/v1"
            ],
            "type": "AlumniCredential",
            "credentialSubject": {
              "name": "Random name",
              "id": "did:hid:testnet:............................."
            },
            "credentialSchema": {
              "id": "sch:hid:testnet:...............",
              "type": "JsonSchemaValidator2018"
            },
            "trustedIssuer": [
              {
                "required": true,
                "issuer": "did:hid:testnet:................"
              }
            ]
          }
        }
      ]
    }
  ]
}
  • POST/api/v1/presentation/template
  • GET/api/v1/presentation/template
  • GET/api/v1/presentation/template/{templateId}
  • PATCH/api/v1/presentation/template/{templateId}
  • DELETE/api/v1/presentation/template/{templateId}
get
Authorizations
Query parameters
pagenumberOptional

Page value

Default: 1
limitnumberOptional

Fetch limited list of data

Default: 10
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Responses
200
List of presentation template
application/json
404
No template has created for appId 42...18-....
application/json
get
GET /api/v1/presentation/template HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "totalCount": 12,
  "data": [
    {
      "appId": "43...18-...........",
      "domain": "fyre.hypersign.id",
      "query": [
        {
          "type": "QueryByExample",
          "credentialQuery": [
            {
              "required": true,
              "reason": "We need you to prove your eligibility to work.",
              "example": {
                "@context": [
                  "https://www.w3.org/2018/credentials/v1"
                ],
                "type": "AlumniCredential",
                "credentialSubject": {
                  "name": "Random name",
                  "id": "did:hid:testnet:............................."
                },
                "credentialSchema": {
                  "id": "sch:hid:testnet:...............",
                  "type": "JsonSchemaValidator2018"
                },
                "trustedIssuer": [
                  {
                    "required": true,
                    "issuer": "did:hid:testnet:................"
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}
post
Authorizations
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Body
domainstringRequired

Domain name

Example: fyre.hypersign.id
namestringRequired

name of the presentation template

Example: alumni_credential_request (sanke_case)
Responses
201
presentaion template Created
application/json
400
name must be unique for an app
application/json
post
POST /api/v1/presentation/template HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 591

{
  "domain": "fyre.hypersign.id",
  "name": "alumni_credential_request (sanke_case)",
  "query": [
    {
      "type": "QueryByExample / DIDAuthentication",
      "credentialQuery": [
        {
          "required": true,
          "reason": "We need you to prove your eligibility to work.",
          "example": {
            "@context": [
              "https://www.w3.org/2018/credentials/v1"
            ],
            "type": "AlumniCredential",
            "credentialSubject": {
              "name": "Random name",
              "id": "did:hid:testnet:............................."
            },
            "credentialSchema": {
              "id": "sch:hid:testnet:...............",
              "type": "JsonSchemaValidator2018"
            },
            "trustedIssuer": [
              {
                "required": true,
                "issuer": "did:hid:testnet:................"
              }
            ]
          }
        }
      ]
    }
  ]
}
{
  "domain": "fyre.hypersign.id",
  "name": "alumni_credential_request (sanke_case)",
  "query": [
    {
      "type": "QueryByExample / DIDAuthentication",
      "credentialQuery": [
        {
          "required": true,
          "reason": "We need you to prove your eligibility to work.",
          "example": {
            "@context": [
              "https://www.w3.org/2018/credentials/v1"
            ],
            "type": "AlumniCredential",
            "credentialSubject": {
              "name": "Random name",
              "id": "did:hid:testnet:............................."
            },
            "credentialSchema": {
              "id": "sch:hid:testnet:...............",
              "type": "JsonSchemaValidator2018"
            },
            "trustedIssuer": [
              {
                "required": true,
                "issuer": "did:hid:testnet:................"
              }
            ]
          }
        }
      ]
    }
  ]
}
patch
Authorizations
Path parameters
templateIdstringRequired
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Body
domainstringOptional

Domain name

Example: fyre.hypersign.id
namestringOptional

name of the presentation template

Example: alumni_credential_request (sanke_case)
Responses
200
Template Updated
application/json
400
Error occured at the time of updating
application/json
patch
PATCH /api/v1/presentation/template/{templateId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 591

{
  "domain": "fyre.hypersign.id",
  "name": "alumni_credential_request (sanke_case)",
  "query": [
    {
      "type": "QueryByExample / DIDAuthentication",
      "credentialQuery": [
        {
          "required": true,
          "reason": "We need you to prove your eligibility to work.",
          "example": {
            "@context": [
              "https://www.w3.org/2018/credentials/v1"
            ],
            "type": "AlumniCredential",
            "credentialSubject": {
              "name": "Random name",
              "id": "did:hid:testnet:............................."
            },
            "credentialSchema": {
              "id": "sch:hid:testnet:...............",
              "type": "JsonSchemaValidator2018"
            },
            "trustedIssuer": [
              {
                "required": true,
                "issuer": "did:hid:testnet:................"
              }
            ]
          }
        }
      ]
    }
  ]
}
{
  "appId": "43...18-...........",
  "domain": "fyre.hypersign.id",
  "query": [
    {
      "type": "QueryByExample",
      "credentialQuery": [
        {
          "required": true,
          "reason": "We need you to prove your eligibility to work.",
          "example": {
            "@context": [
              "https://www.w3.org/2018/credentials/v1"
            ],
            "type": "AlumniCredential",
            "credentialSubject": {
              "name": "Random name",
              "id": "did:hid:testnet:............................."
            },
            "credentialSchema": {
              "id": "sch:hid:testnet:...............",
              "type": "JsonSchemaValidator2018"
            },
            "trustedIssuer": [
              {
                "required": true,
                "issuer": "did:hid:testnet:................"
              }
            ]
          }
        }
      ]
    }
  ]
}