v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
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

Path parameters

submission_heron_idstring required
Example:sub_1a2b3c4d5e6f

The unique identifier for the broker submission to upload files to

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