Sign in
Document

Uploads documents

Use this endpoint to create one or more document records within our system. Use the presigned URLs returned in the response to upload the actual files to our secure S3 buckets.

post/create-documents

Request body

entitystring
entityIdstring
referenceNumbersstring[]
typestring
namestring
contentTypestring

Example request

[
  {
    "entity": "shipment",
    "entityId": "123455678990",
    "referenceNumbers": [
      "REF_NUMBER"
    ],
    "type": "proof_of_delivery",
    "name": "filename",
    "contentType": "application/json"
  }
]

Response

Status Code 200: Successful Response - the request was successful!

originalFileNamestring
presignedUrlstring

Example response

[
  {
    "originalFileName": "filename",
    "presignedUrl": "https://s3-url.com?key-signed-metadata"
  }
]

Changes