Upload Document
Payload is identical in v1 and v2 — no migration needed for this event.
Augment POSTs this payload to your configured upload-document endpoint when a document needs to be associated with a load. The file content is base64-encoded and accompanied by an MD5 checksum for integrity verification.
Supported file types: .pdf, .jpg/.jpeg, .png, .heic, .webp, .tiff/.tif.
Supported fileType values: INVOICE, POD, BOL, RATE_CONFIRMATION, LUMPER_RECEIPT, OTHER.
When uploading an invoice (fileType: INVOICE), the referenceNumbers.invoiceNumber field is required.
The optional source field identifies the entity that provided the document (e.g. a carrier). Use it when your brokerage needs to route documents by origin, such as mapping a carrier by MC number or SCAC code.
Body·
- Type: stringchecksumrequired
MD5 hex digest of the raw (pre-encoding) file bytes, used for integrity verification
- Type: stringcontentrequired
Base64-encoded file bytes
- Type: stringcontent
Type requiredMIME type of the file. Supported values:
application/pdf,image/jpeg,image/png,image/heic,image/webp,image/tiff - Type: stringfilenamerequired
Original filename including extension. Supported extensions:
.pdf,.jpg,.jpeg,.png,.heic,.webp,.tiff,.tif - Type: enumfile
Type requiredThe category of the document being uploaded
valuesINVOICEPODBOLRATE_CONFIRMATIONLUMPER_RECEIPTOTHER - Type: stringload
Num requiredThe load's external number in the TMS (brokerageLoadId)
- Type: integersize
Bytes requiredFile size in bytes
- Type: stringcreated
At ISO 8601 timestamp of when the document was collected/created
- Type: stringinternal
Load Reference Optional internal load identifier from the TMS (brokerageLoadInternalId). Only included when available.
- Properties: 1Type:reference
Numbers - Type:sourceProperties: 4
Origin of the document, used by some brokerages for routing (e.g. carrier ID)
Responses
- application/json
- application/json
{
"loadNum": "",
"internalLoadReference": "",
"filename": "invoice-1234.pdf",
"fileType": "INVOICE",
"contentType": "application/pdf",
"content": "",
"sizeBytes": 1,
"checksum": "",
"referenceNumbers": {
"invoiceNumber": ""
},
"source": {
"type": "CARRIER",
"identifierType": "MC_NUMBER",
"identifier": "",
"name": ""
},
"createdAt": ""
}
{
"summary": {
"total": 1,
"succeeded": 1,
"failed": 1
},
"results": [
{
"filename": "string",
"success": true,
"data": {
"size": 1,
"contentType": "string",
"id": "string"
}
}
]
}