v2

latestOpenAPI 3.0.3raw.githubusercontent.com2026-02-044510.9 KB
Letters

Get a specific letter

Returns the details of a specific letter for a given user and case. Available as raw json, an interpolated template or a PDF stream.

get/letters/{userId}/{caseReferenceNumber}/{letterId}

Response

Details of the requested letter.

OR

Example response

{
  "userId": "223e4567-e89b-12d3-a456-426614174111",
  "caseReferenceNumber": "25-700123",
  "letterId": "123e4567-e89b-12d3-a456-426614174000",
  "letterType": "AA01",
  "letterData": {
    "recipientName": "Mr Test Testcase",
    "caseReference": "25-700123",
    "decisionDate": "2024-01-15"
  }
}