v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB

EndUserIntegrations

Get single PDF by heron_id

Retrieve a single PDF document by its heron_id. Returns the PDF metadata, status information, and optionally the processed statements/transactions. Users can only access their own PDFs.

get/api/integrations/pdfs/{heron_id}

Path parameters

heron_idstring required

The heron_id of the PDF to retrieve

Query parameters

with_processed_resultsboolean

Include processed statements/transactions in the response

Response

Successfully retrieved PDF

Example response

{
  "pdf": {
    "account_id": "checking_account_202348",
    "created": "2026-07-23T19:53:47.257444",
    "currency": "USD",
    "end_user": {
      "heron_id": "eus_WAcrEUnGkmMjYoRJBRbpwc"
    },
    "filename": "my-favourite.pdf",
    "heron_id": "pdf_kfwFjLM8PT5LyGvnJdXL8H",
    "last_updated": "2026-07-23T19:53:47.257489",
    "notes": "failed to send to external OCR provider",
    "reference_id": "my-favourite-pdf",
    "status": "processed"
  }
}