Sign in

v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserIntegrations

Update PDF attributes including status

Update PDF attributes including status

put/api/integrations/pdfs/{heron_id}

Path parameters

heron_idstring required

heron_id of the pdf

Request body

filenamestring

The filename of the PDF

fraud_reasonstring nullable

If fraud reason

is_fraudboolean

True if fraud was detected in the PDF

notesstring

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

reference_idstring

An optional field for your unique identifier for the PDF

status'new' | 'parsing' | 'parsed' | 'processed' | 'human_reviewing' | 'approved' | 'rejected' | 'failed' | 'transactions_loaded' | 'transactions_unloaded'

Status of PDF

Example request

{
  "filename": "my-favourite.pdf",
  "reference_id": "my-favourite-pdf",
  "status": "processed"
}

Response

OK

request_idstring

Unique UUID per request

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"
  }
}