MIministryofjustice
Transfer Tickets

Create an upload transfer ticket

Changed on

Creates either:

  • a single PUT upload ticket for smaller files, or
  • a multipart upload session for larger files.

The client supplies sizeBytes and the API decides which upload path to use.

post/transfer-tickets

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /transfer-tickets
  • Auth
    HTTP bearer

Request body

clientIdstring required
fileNamestring required
contentTypestring
sizeBytesinteger required
requestedExpirySecondsinteger
contentMd5string

Base64-encoded MD5 digest for single PUT uploads only

Example request

{
  "clientId": "products-poc",
  "fileName": "example-upload.csv",
  "contentType": "text/csv",
  "sizeBytes": 12345,
  "requestedExpirySeconds": 900,
  "contentMd5": "CY9rzUYh03PK3k6DJie09g=="
}

Response

Upload session created

OR

Example response

{
  "upload": {
    "method": "PUT"
  }
}

Changes