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-06-19T18:49:44.826888",
"currency": "USD",
"end_user": {
"heron_id": "eus_T589t4U4XsREV6kBVsBCjG"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_GxD7ha3xVVFMzpTCkXYyYa",
"is_image_based": true,
"last_updated": "2025-06-19T18:49:44.826941",
"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>"
}
heron_id of the pdf
OK
The response is of type object
.
Was this page helpful?
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-06-19T18:49:44.826888",
"currency": "USD",
"end_user": {
"heron_id": "eus_T589t4U4XsREV6kBVsBCjG"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_GxD7ha3xVVFMzpTCkXYyYa",
"is_image_based": true,
"last_updated": "2025-06-19T18:49:44.826941",
"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>"
}
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-06-19T18:49:44.826888",
"currency": "USD",
"end_user": {
"heron_id": "eus_T589t4U4XsREV6kBVsBCjG"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_GxD7ha3xVVFMzpTCkXYyYa",
"is_image_based": true,
"last_updated": "2025-06-19T18:49:44.826941",
"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>"
}
heron_id of the pdf
OK
The response is of type object
.
Was this page helpful?
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-06-19T18:49:44.826888",
"currency": "USD",
"end_user": {
"heron_id": "eus_T589t4U4XsREV6kBVsBCjG"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_GxD7ha3xVVFMzpTCkXYyYa",
"is_image_based": true,
"last_updated": "2025-06-19T18:49:44.826941",
"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>"
}