Schema

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

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Body

application/json

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

schemaIdstringRequired

Schema id

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

transactionHashstringRequired

transaction hash for schema

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

400

Error occured at the time of creating schema

application/json

404

Error in finding resource

application/json

post/api/v1/schema

HTTPcURLJavaScriptPython

POST /api/v1/schema HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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.................."
}

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

totalCountnumberRequired

totalCount

Example: 12

404

No schema has created

application/json

get/api/v1/schema

HTTPcURLJavaScriptPython

GET /api/v1/schema HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schemaIdstringRequired

Header parameters

AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

Responses

200

Resolved schema detail

application/json

typestringRequired

type

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

modelVersionstringRequired

version of model

Example: 1.0

idstringRequired

schema id

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

namestringRequired

name of the schema

Example: schema for railway ticket

authorstringRequired

issuer did

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

authoredstringRequired

Time of schema creation

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

404

sch:hid:testnet:...... not on chain

application/json

get/api/v1/schema/{schemaId}

HTTPcURLJavaScriptPython

GET /api/v1/schema/{schemaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
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....."
  }
}