GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
pdfs
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/pdfs \
  --header 'Authorization: Basic <encoded-value>'
{
  "pdfs": [
    {
      "account_id": "checking_account_202348",
      "created": "2025-03-04T17:08:55.798192",
      "currency": "USD",
      "end_user": {
        "heron_id": "eus_NSZoJSg5u4HKVMTYqkCg2z"
      },
      "filename": "my-favourite.pdf",
      "heron_id": "pdf_HLik3GySV9gUY2URC73A45",
      "is_image_based": true,
      "last_updated": "2025-03-04T17:08:55.798222",
      "notes": "failed to send to external OCR provider",
      "parsing_version": "<string>",
      "reference_id": "my-favourite-pdf",
      "statements": [
        {
          "exclude": true,
          "invalid_transaction_partials": [
            {
              "amount": 123,
              "balance": 123,
              "bounds": {
                "page": 123,
                "x_max": 123,
                "x_min": 123,
                "y_max": 123,
                "y_min": 123
              },
              "currency": "<string>",
              "description": "<string>",
              "ocr_suspect": true,
              "reference_id": "<string>",
              "timestamp": "2023-11-07T05:31:56Z",
              "transaction_code": "<string>"
            }
          ],
          "summary": {
            "account_number": "<string>",
            "account_title": "<string>",
            "bank_name": "<string>",
            "company": "<string>",
            "currency": "<string>",
            "end_balance": 123,
            "fraud_reasons": [
              "<string>"
            ],
            "fraud_score": 123,
            "is_business_account": true,
            "is_ocr": true,
            "max_resolution": 123,
            "min_resolution": 123,
            "num_credits": 123,
            "num_debits": 123,
            "num_transactions": 123,
            "reconciled": true,
            "start_balance": 123,
            "statement_end_date": "2023-11-07T05:31:56Z",
            "statement_start_date": "2023-11-07T05:31:56Z",
            "total_credits": 123,
            "total_debits": 123,
            "unreconciled_end_balance": 123,
            "web_report": true
          },
          "transaction_partials": [
            {
              "amount": 123,
              "balance": 123,
              "bounds": {
                "page": 123,
                "x_max": 123,
                "x_min": 123,
                "y_max": 123,
                "y_min": 123
              },
              "currency": "<string>",
              "description": "<string>",
              "ocr_suspect": true,
              "reference_id": "<string>",
              "timestamp": "2023-11-07T05:31:56Z",
              "transaction_code": "<string>"
            }
          ]
        }
      ],
      "status": "processed"
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

end_user_id_or_heron_id
string
required

The end_user_id or heron_id of EndUser to upload

Query Parameters

with_processed_results
boolean

Include processed results where applicable per pdf

Response

200 - application/json
OK
pdfs
object[]