HEherondata
EndUserIntegrations

Get single PDF by heron_id

Changed on

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}

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/integrations/pdfs/{heron_id}
  • Auth
    API key in header x-api-key

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-11-02T23:44:30.814976",
    "currency": "USD",
    "end_user": {
      "heron_id": "eus_hyaMkfjmgiZgrk4d2rMbok"
    },
    "filename": "my-favourite.pdf",
    "heron_id": "pdf_hX7v63EYDYa7gLijntntaE",
    "last_updated": "2026-11-02T23:44:30.815007",
    "notes": "Statement processed successfully. All balances verified.",
    "reference_id": "my-favourite-pdf",
    "status": "processed"
  }
}

Changes

  • bd8008e49534Revision changes
    • breaking

      the response property / became nullable for the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      the response optional property / became read-only for the status