Schema

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

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

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/schema' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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}"
  }'

201

400

404

201

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

Schema Created

get

Authorizations

Query parameters

pagenumber · default: 1optional

Page value

limitnumber · default: 10optional

Fetch limited list of data

Header parameters

Authorizationstringoptional

Bearer <access_token>

Originstringoptional

Origin as you set in application cors

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/schema' \
  --header 'Authorization: Bearer JWT'

200

404

200

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

Schema List

get

Authorizations

Path parameters

schemaIdstringrequired

Header parameters

Authorizationstringoptional

Bearer <access_token>

Originstringoptional

Origin as you set in application cors

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/schema/{schemaId}' \
  --header 'Authorization: Bearer JWT'

200

404

200

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

Resolved schema detail