For the complete documentation index, see llms.txt. This page is also available as Markdown.

Schema

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

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationstringOptional

Bearer <access_token>

OriginstringOptional

Origin as you set in application cors

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
schemaIdstringRequired

Schema id

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

transaction hash for schema

Example: KAGSLKAGDLKJGA..................
post/api/v1/schema
get
Authorizations
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
get/api/v1/schema
get
Authorizations
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
get/api/v1/schema/{schemaId}

Last updated