Developers
Certificates8

Preview a certificate template

POST/products/{product_id}/certificate-template/previews

Renders a sample certificate from the product's current certificate template, using placeholder data.

A preview is not an issued certificate: it does not appear in certificate listings or reports and cannot be verified through public validation. The response does not include a file_id; use pdf_url to access the rendered PDF.

Templates of replicated products cannot be previewed.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/products/string/certificate-template/previews" \  -H "Idempotency-Key: string"
{  "data": {    "id": "string",    "note": "string",    "object": "certificate_preview",    "pdf_url": "string"  }}

Replace a certificate template PUT

Replaces the product's certificate template. Fields omitted from the request body are reset to their default values. The certificate criteria, QR code position, and font must use one of the supported values. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid overwriting a newer version. Templates of replicated products are read-only.

List a user's certificates GET

Returns the certificates issued to the user, including revoked certificates. Deleted certificates are not included. The collection can be filtered by product, status, and issue date, and is paginated with a cursor. When the credentials are restricted to specific products, only certificates for those products are returned. The `fields` object, which contains the document, address, and custom field values recorded at issuance, is included only when the credential has the `users.read_personal` permission.