EndUserIntegrations
Update PDF attributes including status
API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETList EndUsers with Summary Information
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEnricherFields
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- PATCHSet the display order of end user entities
- POSTCreate an end user entity attribute
- PATCHSet the display order of end user entity attributes
- DELDelete an EndUserEntityAttribute
- PATCHUpdate an end user entity
- POSTCreate an end user entity attribute
- POSTCreate an end user entity attribute source
- DELDelete an EndUserEntityAttribute
- PATCHUpsert an end user entity
- DELDelete an EndUserEntity
- PATCHUpdate an end user entity
- GETGet the materialised end user entities for an end user
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- GETGet file rename rule variable slugs
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETRun industry classification on end user files
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- POSTReprocess a single ISO application
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
UserMerchantGroups
Users
EndUserIntegrations
Update PDF attributes including status
Update PDF attributes including status
PUT
/
api
/
integrations
/
pdfs
/
{heron_id}
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-04-30T19:15:20.377555",
"currency": "USD",
"end_user": {
"heron_id": "eus_2PbzLP3BSwiWSCdeaKmSUT"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_jgWS5eqvUFBYQtHpTULtWa",
"is_image_based": true,
"last_updated": "2025-04-30T19:15:20.377577",
"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
Path Parameters
heron_id of the pdf
Body
application/json
Response
200 - application/json
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-04-30T19:15:20.377555",
"currency": "USD",
"end_user": {
"heron_id": "eus_2PbzLP3BSwiWSCdeaKmSUT"
},
"filename": "my-favourite.pdf",
"heron_id": "pdf_jgWS5eqvUFBYQtHpTULtWa",
"is_image_based": true,
"last_updated": "2025-04-30T19:15:20.377577",
"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>"
}