Templates

Templates are used for presenting verifiable credentials to the user in a a pretty, readable and informative way. They can be used on the persisted credentials web view in Truvera workspace or for downloading credentials as PDF document. We have a Designer function in the Truvera Workspace for creating Design templates.

We also have a library https://github.com/docknetwork/prettyvc that can be used to create templates and has samples of templates for users that want more customisation for their designs or use the same principal for their wallet credential display.

Create a template

post

/templates

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

htmlstring · max: 10000000Required

The HTML content of the template

cssstring · max: 10000000Required

The CSS content of the template

namestring · max: 256Required

The name of the template

Responses

200

template has been created

application/json

idstringRequired

htmlstringOptional

cssstringOptional

namestringRequired

metadataobjectOptional

400

Error creating template

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

User does not own template DID

application/json

post/templates

POST /templates HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "html": "text",
  "css": "text",
  "name": "text"
}

{
  "id": "text",
  "html": "text",
  "css": "text",
  "name": "text",
  "metadata": {}
}

List all templates

get

/templates

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0

limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64

Responses

200

A paged array of templates

application/json

idstringRequired

htmlstringOptional

cssstringOptional

namestringRequired

metadataobjectOptional

400

Application error

application/json

get/templates

GET /templates HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "html": "text",
    "css": "text",
    "name": "text",
    "metadata": {}
  }
]

Info for a specific template by DID

get

/templates/{id}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

The template ID

Responses

200

Expected response to a valid request

application/json

idstringRequired

htmlstringOptional

cssstringOptional

namestringRequired

metadataobjectOptional

400

Error getting template

application/json

404

template was not found

application/json

get/templates/{id}

GET /templates/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "html": "text",
  "css": "text",
  "name": "text",
  "metadata": {}
}

Update a template

patch

/templates/{id}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

A template ID

Body

htmlstring · max: 10000000Required

The HTML content of the template

cssstring · max: 10000000Required

The CSS content of the template

namestring · max: 256Required

The name of the template

Responses

200

Template has been updated

application/json

idstringRequired

htmlstringOptional

cssstringOptional

namestringRequired

metadataobjectOptional

400

Error creating template

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

patch/templates/{id}

PATCH /templates/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "html": "text",
  "css": "text",
  "name": "text"
}

{
  "id": "text",
  "html": "text",
  "css": "text",
  "name": "text",
  "metadata": {}
}

Deletes a single template based on ID provided

delete

/templates/{id}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

A template ID

Responses

200

Template deleted

No content

400

Error deleting template

application/json

404

template was not found

application/json

delete/templates/{id}

DELETE /templates/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content