Hypersign.id Entity Studio Identity Wallet

Presentation Template

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

PreviousVerifiable Presentation NextPresentation

Last updated 2 years ago

get

Authorizations

Path parameters

templateIdstringrequired

Header parameters

Authorizationstringoptional

Bearer <access_token>

Originstringoptional

Origin as you set in application cors

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/presentation/template/{templateId}' \
  --header 'Authorization: Bearer JWT'

200

404

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

Presentation template detail

delete

Authorizations

Path parameters

templateIdstringrequired

Header parameters

Authorizationstringoptional

Bearer <access_token>

Originstringoptional

Origin as you set in application cors

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/presentation/template/{templateId}' \
  --header 'Authorization: Bearer JWT'

200

404

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

Template Deleted Successfully

get

Authorizations

Query parameters

pagenumber · default: 1optional

Page value

limitnumber · default: 10optional

Fetch limited list of data

Header parameters

Authorizationstringoptional

Bearer <access_token>

Originstringoptional

Origin as you set in application cors

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/presentation/template' \
  --header 'Authorization: Bearer JWT'

200

404

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

List of presentation template

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/presentation/template' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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:................"
                }
              ]
            }
          }
        ]
      }
    ]
  }'

201

400

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

presentaion template Created

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/v1/presentation/template/{templateId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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:................"
                }
              ]
            }
          }
        ]
      }
    ]
  }'

200

400

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

Template Updated

Show child attributes

Show child attributes