HEherondata
BrokerSubmissions

Upload PDF files for broker submission

Upload one or more PDF files for a specified broker submission. Authenticate by passing a broker API key in the x-api-key header. Generate keys via the /api/broker_submissions/api_keys/generate endpoint.

post/api/broker_submissions/{submission_heron_id}/files

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/broker_submissions/{submission_heron_id}/files
  • Auth
    API key in header x-api-key

Path parameters

submission_heron_idstring required
Example:sub_1a2b3c4d5e6f

The unique identifier for the broker submission to upload files to

Request body multipart/form-data

downstream_processingboolean

(Optional) Whether to trigger downstream processing (classification, parsing, Flowmingo workflow start, etc.) after the files are uploaded. Defaults to true to preserve existing behaviour. Set to false to upload files without triggering downstream processing — useful when uploading multiple files in sequence and you only want the workflow to start after the final upload.

file_classstring

(Optional) The type of document being uploaded. Applies to all files in this request. If omitted, Heron's file classifier will automatically determine the file type. Common values: bank_statement, iso_application_form, debt_summary, void_check, invoice, pnl_statement, balance_sheet, tax_return.

filesstring[] required

Array of PDF files to upload.

Example request

{
  "downstream_processing": true,
  "file_class": "bank_statement"
}

Response

All files uploaded successfully

filestring

Name of the uploaded file

status'uploaded'

Status of the file upload

Example response

[
  {
    "file": "statement_q4.pdf",
    "status": "uploaded"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.