Docs
DevelopersReferenceDocuments

API: Upload A Document

POST
/v1/itineraries/{id}/documents

Uploads a sealed (already encrypted) document as multipart/form-data, up to 20 MB. Requires Travelyfe Pro. Documents are encrypted on the traveller's own devices before upload, so a file that is not sealed is refused as documentNotSealed; this route is for clients that can seal files.

AuthorizationBearer <token>

A Travelyfe access token.

In: header

Path Parameters

id*string

The itinerary id (UUID).

Formatuuid

Header Parameters

Travelyfe-Itinerary-Shape?"clean"

Send clean on every request that reads or writes an itinerary. It is the shape this reference documents.

Value in

  • "clean"

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/itineraries/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents" \  -F file="string"
{  "id": "string",  "name": "string",  "kind": "string",  "mimeType": "string",  "size": 0,  "url": "http://example.com"}