Presentation Template

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

domainstringRequired

Domain name

Example: fyre.hypersign.id

namestringRequired

name of the presentation template

Example: alumni_credential_request (sanke_case)

queryobject[]Required

query parameter for requesting presentation

Responses

application/json

objectOptional

application/json

post

HTTPcURLJavaScriptPython

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

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

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

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

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

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

domainstringOptional

Domain name

Example: fyre.hypersign.id

namestringOptional

name of the presentation template

Example: alumni_credential_request (sanke_case)

queryobject[]Optional

query parameter for requesting presentation

Responses

application/json

objectOptional

application/json

patch

HTTPcURLJavaScriptPython

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

application/json

objectOptional

application/json

delete

HTTPcURLJavaScriptPython

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:................"
              }
            ]
          }
        }
      ]
    }
  ]
}