Download PDF

Download a credential document as a PDF file. The credential must be of type DOCUMENT and belong to your organization. If the credential has signatures, the returned PDF will include signature pages. If the credential has no signatures, the original document is returned. The file content is returned as a base64-encoded string that can be decoded and saved as a PDF file.

GET /v1/resource/download/{id}

Download PDF

cURL

curl --request GET \
  --url https://api.example.com/v1/resource/download/{id}

200

{
  "fileContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQo+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNTkgMDAwMDAgbiAKMDAwMDAwMDEwNSAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDQKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjE3MQolJUVPRg==",
  "internalId": "internal-credential-123"
}

Path Parameters

id · string · required

Unique identifier of the credential to download. Must be a valid MongoDB ObjectId. The credential must be of type DOCUMENT.

Example:

"507f1f77bcf86cd799439011"

Response

200

application/json

Credential PDF downloaded successfully. Returns the base64-encoded PDF file content and the internal ID of the credential (if provided).

fileContent · string · required

Base64-encoded PDF file content of the credential document. This is the actual PDF file that can be decoded and saved. If the credential has signatures, the PDF will include signature pages. If the credential has no signatures or onlyContent is true, the original document is returned.

Example:

"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQo+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4gCjAwMDAwMDAwNTkgMDAwMDAgbiAKMDAwMDAwMDEwNSAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDQKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjE3MQolJUVPRg=="

internalId · string | null

Internal ID of the credential. This is the internal ID of the credential that was used to create the PDF. Null if no internal ID was provided.

Example:

"internal-credential-123"