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

Schema

PreviousDIDNextVerifiable Credential

Last updated 6 months ago

Entity Studio SSI API base URL:

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

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Responses
200
Resolved schema detail
application/json
404
sch:hid:testnet:...... not on chain
application/json
get
GET /api/v1/schema/{schemaId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "type": "https://w3c-ccg.github.io/vc-json-schemas/v1/schema/1.0/schema.json",
  "modelVersion": "1.0",
  "id": "sh:his:testnet:.................",
  "name": "schema for railway ticket",
  "author": "did:hid:testnet:..........",
  "authored": "2023-01-24T14:35:53Z",
  "Schema": {
    "schema": "http://json-schema.org/draft-07/schema",
    "description": "schema for railway ticket",
    "type": "object",
    "properties": "schema for railway ticket",
    "required": "object",
    "require": [
      true
    ]
  },
  "proof": {
    "type": "Ed25519VerificationKey2020",
    "created": "2023-01-24T14:35:53Z",
    "verificationMethod": "did:hid:testnet:..............",
    "proofPurpose": "assertion",
    "proofValue": "8jKQBTUnY2k5n2rNFwuI.....Jyyco6uYJtG7HM4ojnmwUCa....."
  }
}
  • POST/api/v1/schema
  • GET/api/v1/schema
  • GET/api/v1/schema/{schemaId}
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
Schema List
application/json
404
No schema has created
application/json
get
GET /api/v1/schema HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
[
  {
    "totalCount": 12,
    "data": [
      "sch:hid:testnet:............"
    ]
  }
]
post
Authorizations
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Body
schemaall ofRequired

Schema body

namespacestringRequired

Namespace to be added in did.

Example: testnet
verificationMethodIdstringRequired

Verification Method id for did updation

Example: did:hid:testnet:........#key-${idx}
Responses
201
Schema Created
application/json
400
Error occured at the time of creating schema
application/json
404
Error in finding resource
application/json
post
POST /api/v1/schema HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "schema": {
    "name": "Railway ticket schema",
    "author": "did:hid:namespace:................",
    "description": "Railway ticket schema\"",
    "additionalProperties": false,
    "fields": [
      {
        "name": "name",
        "format": "",
        "type": "string",
        "isRequired": false
      }
    ]
  },
  "namespace": "testnet",
  "verificationMethodId": "did:hid:testnet:........#key-${idx}"
}
{
  "schemaId": "sch:hid:namespce:.....................",
  "transactionHash": "KAGSLKAGDLKJGA.................."
}