Credentials

Get credential design templates

Use this endpoint to list the ordered design templates used by a credential and their available previews. Preview URLs are immutable and versioned by a digest (hash) derived from the design template's last update timestamp and the resolved values of all rendered credential attributes.

<Callout title="Important considerations" type="warn"> Preview URLs are immutable and versioned by a digest (hash) derived from:
  • the design template’s last update timestamp, and
  • the resolved values of all rendered credential attributes

If you modify the design template (layout, fonts, colors, etc.) or any attribute value that appears in the design template, the digest changes and previous preview URLs will not automatically point to the new design template.

To get the newest preview after any change, fetch Get credential design templates again and use the newly returned preview URL.

The digest-versioned URL (…/.png or .pdf) is permanent for that exact version and is cache-friendly, making it safe to store or share. </Callout>

get/v1/credentials/{id}/designs

Path parameters

idstring required

The unique ID of the credential

Example:01hz2f0c9ryvzajg20jqh9taab

The unique ID of the credential

Headers

Certifier-Versionstring required

API version header. Required for all requests.

Example:2022-10-26

API version header. Required for all requests.

Response

List of design templates associated with the credential

idstring required

Unique identifier for the design template

namestring required

Name of the design template

Example response

[
  {
    "id": "01jpqe836f59e62yh4c06h5sd8",
    "name": "Classic Certificate",
    "previews": [
      {
        "format": "png",
        "url": "https://cdn.certifier.io/c2903a31-67f2-4439-8214-5aeab5808536/credentials/01jjcded4kr5t0zz33286qqtxv/designs/01jpqe836f59e62yh4c06h5sd8/YhOo_ijQbQ.png"
      }
    ]
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.