Presentation Template

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

POST/api/v1/presentation/template

Authorization

Authorization

Header parameters

Body

application/json

domain*string

Domain name

Example: "fyre.hypersign.id"

name*string

name of the presentation template

Example: "alumni_credential_request (sanke_case)"

query*array of Query (object)

query parameter for requesting presentation

Response

201400

presentaion template Created

Body

application/json

domain*string

Domain name

Example: "fyre.hypersign.id"

name*string

name of the presentation template

Example: "alumni_credential_request (sanke_case)"

query*array of Query (object)

query parameter for requesting presentation

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/presentation/template', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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:................"
                  }
                ]
              }
            }
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

201400

{
  "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/api/v1/presentation/template

Authorization

Authorization

Query parameters

Header parameters

Response

200404

List of presentation template

Body

application/json

totalCount*number

totalCount

Example: 12

data*array of PresentationTemplate (object)

data

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/presentation/template', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "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/api/v1/presentation/template/{templateId}

Authorization

Authorization

Path parameters

templateId*string

Header parameters

Response

200404

Presentation template detail

Body

application/json

appId*string

Application Id

Example: "43...18-..........."

domain*string

Domain name

Example: "fyre.hypersign.id"

query*all of

Domain name

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/presentation/template/{templateId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "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/api/v1/presentation/template/{templateId}

Authorization

Authorization

Path parameters

templateId*string

Header parameters

Body

application/json

domainstring

Domain name

Example: "fyre.hypersign.id"

namestring

name of the presentation template

Example: "alumni_credential_request (sanke_case)"

queryarray of Query (object)

query parameter for requesting presentation

Response

200400

Template Updated

Body

application/json

appId*string

Application Id

Example: "43...18-..........."

domain*string

Domain name

Example: "fyre.hypersign.id"

query*all of

Domain name

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/presentation/template/{templateId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "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/api/v1/presentation/template/{templateId}

Authorization

Authorization

Path parameters

templateId*string

Header parameters

Response

200404

Template Deleted Successfully

Body

application/json

appId*string

Application Id

Example: "43...18-..........."

domain*string

Domain name

Example: "fyre.hypersign.id"

query*all of

Domain name

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/presentation/template/{templateId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

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