curl --request PUT \
--url https://app.herondata.io/api/integrations/pdfs/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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-12-12T10:00:53.668689",
"currency": "USD",
"end_user": {
"heron_id": "eus_7LXGsUNgVvLQBdN6AriatL"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_mxjcqdyUuUv8yJXmCBbYp6",
"is_image_based": true,
"last_updated": "2025-12-12T10:00:53.668754",
"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": {
"end_balance": 123,
"num_credits": 123,
"num_debits": 123,
"num_transactions": 123,
"reconciled": true,
"start_balance": 123,
"total_credits": 123,
"total_debits": 123,
"account_number": "<string>",
"account_title": "<string>",
"bank_name": "<string>",
"company": "<string>",
"currency": "<string>",
"fraud_reasons": [
"<string>"
],
"fraud_score": 123,
"is_business_account": true,
"is_ocr": true,
"max_resolution": 123,
"min_resolution": 123,
"statement_end_date": "2023-11-07T05:31:56Z",
"statement_start_date": "2023-11-07T05:31:56Z",
"unreconciled_end_balance": 123,
"web_report": true
},
"transaction_partials": [
{
"amount": 123,
"description": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"balance": 123,
"bounds": {
"page": 123,
"x_max": 123,
"x_min": 123,
"y_max": 123,
"y_min": 123
},
"currency": "<string>",
"ocr_suspect": true,
"reference_id": "<string>",
"transaction_code": "<string>"
}
]
}
],
"status": "processed"
},
"request_id": "<string>"
}Update PDF attributes including status
curl --request PUT \
--url https://app.herondata.io/api/integrations/pdfs/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--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-12-12T10:00:53.668689",
"currency": "USD",
"end_user": {
"heron_id": "eus_7LXGsUNgVvLQBdN6AriatL"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_mxjcqdyUuUv8yJXmCBbYp6",
"is_image_based": true,
"last_updated": "2025-12-12T10:00:53.668754",
"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": {
"end_balance": 123,
"num_credits": 123,
"num_debits": 123,
"num_transactions": 123,
"reconciled": true,
"start_balance": 123,
"total_credits": 123,
"total_debits": 123,
"account_number": "<string>",
"account_title": "<string>",
"bank_name": "<string>",
"company": "<string>",
"currency": "<string>",
"fraud_reasons": [
"<string>"
],
"fraud_score": 123,
"is_business_account": true,
"is_ocr": true,
"max_resolution": 123,
"min_resolution": 123,
"statement_end_date": "2023-11-07T05:31:56Z",
"statement_start_date": "2023-11-07T05:31:56Z",
"unreconciled_end_balance": 123,
"web_report": true
},
"transaction_partials": [
{
"amount": 123,
"description": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"balance": 123,
"bounds": {
"page": 123,
"x_max": 123,
"x_min": 123,
"y_max": 123,
"y_min": 123
},
"currency": "<string>",
"ocr_suspect": true,
"reference_id": "<string>",
"transaction_code": "<string>"
}
]
}
],
"status": "processed"
},
"request_id": "<string>"
}heron_id of the pdf
The filename of the PDF
"my-favourite.pdf"
If fraud reason
True if fraud was detected in the PDF
Notes associated with PDF, e.g., rejected reason, failed reason
An optional field for your unique identifier for the PDF
140"my-favourite-pdf"
Status of PDF
new, parsing, parsed, processed, human_reviewing, approved, rejected, failed, transactions_loaded, transactions_unloaded "processed"
OK
Show child attributes
Unique ID for account associated with PDF
"checking_account_202348"
Timestamp when PDF was created in Heron system
"2025-12-12T10:00:53.668689"
ISO 4217 currency code for transactions in account. We currently only support GBP and USD PDFs
USD, GBP "USD"
The filename of the PDF
"my-favourite.pdf"
ID generated by Heron Data
"pdf_mxjcqdyUuUv8yJXmCBbYp6"
True if the PDF was processed using image-based OCR. None if not yet processed
Timestamp when PDF was last updated in Heron system
"2025-12-12T10:00:53.668754"
Notes for the PDF, e.g., failed reason
"failed to send to external OCR provider"
Indicates which provider was used to parse this pdf
An optional field for your unique identifier for the PDF
"my-favourite-pdf"
Show child attributes
True if the statement should be excluded from processing
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Status of PDF
new, parsing, parsed, processed, human_reviewing, approved, rejected, failed, transactions_loaded, transactions_unloaded "processed"
Unique UUID per request
Was this page helpful?