Skip to main content

Certificate via a Share Token

Retrieving a Certificate with a Share Token​

This section of the API allows users to download a PDF file of their certificate using a unique Share Token, provided via the Certificall administration.

Endpoint​

GET /case/:shareToken

Description​

This endpoint allows retrieving the PDF file of a specific certificate using a shareToken. This mechanism facilitates sharing and retrieving certificates without requiring additional authentication.

Obtaining the shareToken​

The shareToken needed to access the certificate can be obtained via the Certificall administration interface. For more details on how to obtain this token, please refer to the administration documentation.

Request​

Route Parameters​

  • :shareToken (String): Unique Share Token associated with the certificate to retrieve.

Response​

Successful Response​

  • Content Type: application/pdf
  • Content Disposition: PDF file download as an attachment.
  • File Name: Uses the specified file name, otherwise a default name (certificate.pdf).

Response header example:

Content-Type: application/pdf
Content-Disposition: attachment; filename="file_name.pdf"

Response Body​

The response body contains the certificate PDF file.

Usage​

To use this endpoint, send a GET request with the appropriate shareToken. The certificate PDF file will be downloaded.

Use Cases​

This endpoint is useful for quickly sharing a certificate or accessing a certificate without a full authentication process.

Best Practices​

  • Ensure that the shareToken is valid and corresponds to the desired certificate.
  • Use this endpoint in secure contexts to avoid unauthorized disclosure of certificates.

With this information, you can securely retrieve the PDF file of your certificate using a Share Token obtained via the Certificall administration.