light-mode-image
Learn
MATTR VII PlatformJSON

Update a presentation template

Updates an existing presentation template by its ID.

Analytics Events

PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_STARTPRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_SUCCESSPRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_FAIL

Roles

adminverifier
PUT/v2/credentials/web-semantic/presentations/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Presentation template ID

Request Body

id?string
domainstring

Informs the wallet holder what domain is the verification request coming from. The value must match your tenant URL or your custom domain (if you have one set up). If the domain validation is unsuccessful, the wallet will not let the user proceed with the verification workflow.

namestring

Unique value that is used internally to manage your templates. It must be unique across all presentation templates on your tenant, but is not shown to the holder.

queryarray<CreatePresentationQueryByExample | CreatePresentationQueryByFrame | CreatePresentationDidAuthTemplate>

Indicates what type of query method would be used by presentation requests created from this presentation template:

  • QueryByExample: This query method uses the credential type and trustedIssuer to only accept verifiable presentations that match these parameters.
  • QueryByFrame: This query method is used to create presentation requests that only require specific claims in the verifiable presentations and thus enable selective disclosure.
  • DidAuth: This query method id used to authenticate with the tenant and provide the holder's DID. You can request multiple credentials in one request by adding additional credentialQuery objects to the query array.

Response Body

curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/web-semantic/presentations/templates/string" \  -H "Content-Type: application/json" \  -d '{    "domain": "string",    "name": "string",    "query": [      {        "type": "QueryByExample",        "credentialQuery": [          {            "required": true,            "example": [              {                "@context": [                  null                ],                "type": "AlumniCredential",                "trustedIssuer": [                  {                    "required": true,                    "issuer": "string"                  }                ]              }            ]          }        ]      }    ]  }'
{
  "id": "64e45290-9980-11ea-b872-f1bee5fb328f",
  "domain": "tenant.vii.mattr.global",
  "name": "alumni_credential_request",
  "query": [
    {
      "type": "QueryByExample",
      "credentialQuery": [
        {
          "required": true,
          "reason": "string",
          "example": [
            {
              "@context": [
                null
              ],
              "type": "AlumniCredential",
              "trustedIssuer": [
                {
                  "required": true,
                  "issuer": "string"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

How would you rate this page?

Retrieve a presentation template GET

Previous Page

Delete a presentation template DELETE

Next Page