Skip to content
Hedge Developer Docs

Broker Upload Submission Document

POST
/api/v1/broker/submissions/{submission_id}/documents
curl --request POST \
  --url https://example.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/documents \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file \
  --form display_name=example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
submission_id
required
Submission Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typemultipart/form-data
Body_broker_upload_submission_document_api_v1_broker_submissions__submission_id__documents_post
object
file
required
File
string format: binary
display_name
Any of:
string

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
BrokerFinalizedDocument

One form/document on a submission, read-only for the broker.

download_path is a broker-authed streaming route the portal hits with its bearer token (mirrors BrokerPolicyDocument).

object
id
required
Id
string format: uuid
source
required
Source
string
source_label
required
Source Label
string
display_name
required
Display Name
string
size_bytes
required
Size Bytes
integer
content_type
required
Content Type
string
created_at
Any of:
string format: date-time
download_path
required
Download Path
string
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "source": "example",
  "source_label": "example",
  "display_name": "example",
  "size_bytes": 1,
  "content_type": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "download_path": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}