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
namespacestringRequiredExample:
Namespace to be added in did.
testnet
verificationMethodIdstringRequiredExample:
Verification Method id for did updation
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.................."
}
get
Authorizations
Query parameters
pagenumberOptionalDefault:
Page value
1
limitnumberOptionalDefault:
Fetch limited list of data
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:............"
]
}
]
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....."
}
}
Last updated