Presentation Template
post
Authorizations
Header parameters
AuthorizationstringOptional
Bearer <access_token>
OriginstringOptional
Origin as you set in application cors
Body
domainstringRequiredExample:
Domain name
fyre.hypersign.id
namestringRequiredExample:
name of the presentation template
alumni_credential_request (sanke_case)
Responses
201
presentaion template Created
application/json
400
name must be unique for an app
application/json
post
POST /api/v1/presentation/template HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 591
{
"domain": "fyre.hypersign.id",
"name": "alumni_credential_request (sanke_case)",
"query": [
{
"type": "QueryByExample / DIDAuthentication",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
{
"domain": "fyre.hypersign.id",
"name": "alumni_credential_request (sanke_case)",
"query": [
{
"type": "QueryByExample / DIDAuthentication",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
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
List of presentation template
application/json
404
No template has created for appId 42...18-....
application/json
get
GET /api/v1/presentation/template HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"totalCount": 12,
"data": [
{
"appId": "43...18-...........",
"domain": "fyre.hypersign.id",
"query": [
{
"type": "QueryByExample",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
]
}
get
Authorizations
Path parameters
templateIdstringRequired
Header parameters
AuthorizationstringOptional
Bearer <access_token>
OriginstringOptional
Origin as you set in application cors
Responses
200
Presentation template detail
application/json
404
Resource not found
application/json
get
GET /api/v1/presentation/template/{templateId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"appId": "43...18-...........",
"domain": "fyre.hypersign.id",
"query": [
{
"type": "QueryByExample",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
patch
Authorizations
Path parameters
templateIdstringRequired
Header parameters
AuthorizationstringOptional
Bearer <access_token>
OriginstringOptional
Origin as you set in application cors
Body
domainstringOptionalExample:
Domain name
fyre.hypersign.id
namestringOptionalExample:
name of the presentation template
alumni_credential_request (sanke_case)
Responses
200
Template Updated
application/json
400
Error occured at the time of updating
application/json
patch
PATCH /api/v1/presentation/template/{templateId} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 591
{
"domain": "fyre.hypersign.id",
"name": "alumni_credential_request (sanke_case)",
"query": [
{
"type": "QueryByExample / DIDAuthentication",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
{
"appId": "43...18-...........",
"domain": "fyre.hypersign.id",
"query": [
{
"type": "QueryByExample",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
delete
Authorizations
Path parameters
templateIdstringRequired
Header parameters
AuthorizationstringOptional
Bearer <access_token>
OriginstringOptional
Origin as you set in application cors
Responses
200
Template Deleted Successfully
application/json
404
No resource found for templateId 63d7c558743fea9d22aab...
application/json
delete
DELETE /api/v1/presentation/template/{templateId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"appId": "43...18-...........",
"domain": "fyre.hypersign.id",
"query": [
{
"type": "QueryByExample",
"credentialQuery": [
{
"required": true,
"reason": "We need you to prove your eligibility to work.",
"example": {
"@context": [
"https://www.w3.org/2018/credentials/v1"
],
"type": "AlumniCredential",
"credentialSubject": {
"name": "Random name",
"id": "did:hid:testnet:............................."
},
"credentialSchema": {
"id": "sch:hid:testnet:...............",
"type": "JsonSchemaValidator2018"
},
"trustedIssuer": [
{
"required": true,
"issuer": "did:hid:testnet:................"
}
]
}
}
]
}
]
}
Last updated