Generate pre-populated PDF letters from your letter templates in Claimable.
Claims have access to various letter templates installed in your Claimable account which can be rendered as a PDF document on-demand, pre-populated with relevant details from the claim they relate to.
You can browse and generate these letters via the Claimable API to automate claim communications and letter/document issuance.
Letters can only be fetched and generated within the context of a claim and can't exist outside of a claim.
The Letter Object
Letter Object| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | The unique ID for the letter given by Claimable. |
| name | String | Read Only. The name/title of the letter to help identify it and describe its purpose. |
| download_url | String | Read Only. The URL to download the PDF letter. This is a one-time-use URL that should be consumed before download_url_expires_at. The URL will only be populated after first making a POST request to /claims/:claim_id/letters/:letter_id/generate. |
| download_url_expires_at | Timestamp | Read Only. Indicates when the download_url expires. After consumption or expiry a new URL needs to be generated. |
| last_generated_at | Timestamp | Read Only. When this letter was last generated. |
| last_generated_by | Integer | Read Only. The user who last generated this letter. |
| last_generated_recipient | Object | Read Only. A Recipient object that identifies the recipient of the last generated letter. |
{
"id": 123,
"name": "Initial Claim Acknowledgement Letter",
"download_url": "https://api.claimable.com/claims/123456/letters/123.pdf?export_token=XXX",
"download_url_expires_at": "2025-11-11T13:30:00.560Z",
"last_generated_at": "2025-11-11T13:29:00.573Z",
"last_generated_by": 111,
"last_generated_recipient": {
"id": 1234,
"type": "contact"
}
}The Recipient Object
Recipient Object| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | The unique ID for the recipient record given by Claimable. |
| type | String | One of: contact or company. Letter recipients can be either contact or company. |
{
"id": 1234,
"type": "contact"
}