PUT
/
api
/
integrations
/
pdfs
/
{heron_id}
curl --request PUT \
  --url https://app.herondata.io/api/integrations/pdfs/{heron_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filename": "my-favourite.pdf",
  "fraud_reason": "<string>",
  "is_fraud": true,
  "notes": "<string>",
  "reference_id": "my-favourite-pdf",
  "status": "processed"
}'
{
  "pdf": {
    "account_id": "checking_account_202348",
    "created": "2025-04-15T17:04:45.052790",
    "currency": "USD",
    "end_user": {
      "heron_id": "eus_eax7aztRyuAq5wvtsBZZSQ"
    },
    "filename": "my-favourite.pdf",
    "heron_id": "pdf_kEX9DHWesmPHC8jXV96BpP",
    "is_image_based": true,
    "last_updated": "2025-04-15T17:04:45.052825",
    "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"
  },
  "request_id": "<string>"
}

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

​
heron_id
string
required

heron_id of the pdf

Body

application/json
​
filename
string

The filename of the PDF

Example:

"my-favourite.pdf"

​
fraud_reason
string | null

If fraud reason

​
is_fraud
boolean

True if fraud was detected in the PDF

​
notes
string

Notes associated with PDF, e.g., rejected reason, failed reason

​
reference_id
string

An optional field for your unique identifier for the PDF

Maximum length: 140
Example:

"my-favourite-pdf"

​
status
enum<string>

Status of PDF

Available options:
new,
parsing,
parsed,
processed,
human_reviewing,
approved,
rejected,
failed,
transactions_loaded,
transactions_unloaded
Example:

"processed"

Response

200 - application/json
OK
​
pdf
object
​
request_id
string

Unique UUID per request

Was this page helpful?