Schema

Entity Studio SSI API base URL: https://api.entity.hypersign.id

POST/api/v1/schema

Authorization

Authorization

Header parameters

Body

application/json

schema*all of

Schema body

namespace*string

Namespace to be added in did.

Example: "testnet"

verificationMethodId*string

Verification Method id for did updation

Example: "did:hid:testnet:........#key-${idx}"

Response

201400404

Schema Created

Body

application/json

schemaId*string

Schema id

Example: "sch:hid:namespce:....................."

transactionHash*string

transaction hash for schema

Example: "KAGSLKAGDLKJGA.................."

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/schema', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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}"
    }),
});
const data = await response.json();

Response

201400404

{
  "schemaId": "sch:hid:namespce:.....................",
  "transactionHash": "KAGSLKAGDLKJGA.................."
}

GET/api/v1/schema

Authorization

Authorization

Query parameters

Header parameters

Response

200404

Schema List

Body

application/json

totalCount*number

totalCount

Example: 12

data*array of Schemas (object)

data

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/schema', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

[
  {
    "totalCount": 12,
    "data": [
      "sch:hid:testnet:............"
    ]
  }
]

GET/api/v1/schema/{schemaId}

Authorization

Authorization

Path parameters

schemaId*string

Header parameters

Response

200404

Resolved schema detail

Body

application/json

type*string

type

Example: "https://w3c-ccg.github.io/vc-json-schemas/v1/schema/1.0/schema.json"

modelVersion*string

version of model

Example: "1.0"

id*string

schema id

Example: "sh:his:testnet:................."

name*string

name of the schema

Example: "schema for railway ticket"

author*string

issuer did

Example: "did:hid:testnet:.........."

authored*string

Time of schema creation

Example: "2023-01-24T14:35:53Z"

Schema*all of

Resolved schema Document

proof*all of

proof of schema

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/schema/{schemaId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "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....."
  }
}