Create multiple trips

Create multiple trips at once for specified travelers. Set includeCompleteness: true to receive each trip's completeness in the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of trips to create, including the required travelerIds.

values
object
required

this property requires all relevant trip data

string
enum
required
Allowed:
payload
object

Optional integration payload forwarded with the trip

userAnswers
object

User answers to risk assessment questions

boolean

Skip policy days validation (e.g. when copying a trip)

boolean

Create the trip even when an identical active trip (same traveler, type, destination, dates) exists. Honored only for super-admins; silently ignored for every other role.

legs
array of objects

Ordered destination legs. Only honored for companies with multi-destination enabled; ignored otherwise. Omit for single-destination trips.

legs
processKeys
array of strings | null

Which compliance processes this trip may trigger, by process key (GET /processes lists the keys enabled for your company). Omit or send null to run every process that applies to the route (default). Send a list to run only those keys, or [] to run none. Unknown keys are rejected with 400. A process left out is not filed: GET /trips/{id}/processes reports it as suppressed_by_request, and POST /processes/rerun/{tripId} starts it later and adds it to this list.

Available process keys. Your company can use only the keys linked to it: GET /processes returns that list, and any other key is rejected with 400.

Social security (A1 / certificate of coverage), filed for the country of employment (origin):

KeyCountryProcess
a1-atAustriaA1 certificate (ELDA)
a1-bgBulgariaA1 certificate
a1-chSwitzerlandA1 certificate (ALPS)
a1-cyCyprusA1 certificate
a1-czCzech RepublicA1 certificate
a1-deGermanyA1 certificate
a1-dkDenmarkA1 certificate
a1-gb-requestUnited KingdomA1 certificate
a1-nlNetherlandsA1 certificate
a1-plPolandA1 certificate
a1-seSwedenA1 certificate (FK6220, by post)
long-a1-deGermanyLong-term A1 certificate
aus-deGermanyAusstrahlung
coc-atAustriaCertificate of coverage (ELDA)
coc-chSwitzerlandCertificate of coverage
coc-cyCyprusCertificate of coverage (filed by ops)
coc-deGermanyCertificate of coverage
coc-gbUnited KingdomCertificate of coverage
coc-plPolandCertificate of coverage
ssc-statement—Social security statement (replaces an A1)

Posted-worker notifications, filed for the destination country:

KeyCountryProcess
pwd-atAustriaPosted-worker notification
pwd-beBelgiumPosted-worker notification
pwd-bgBulgariaPosted-worker notification
pwd-chSwitzerlandPosted-worker notification
pwd-cyCyprusPosted-worker notification
pwd-czCzech RepublicPosted-worker notification
pwd-deGermanyPosted-worker notification
pwd-dkDenmarkPosted-worker notification
pwd-eeEstoniaPosted-worker notification
pwd-esSpainPosted-worker notification
pwd-fiFinlandPosted-worker notification
pwd-frFrancePosted-worker notification
pwd-grGreecePosted-worker notification
pwd-hrCroatiaPosted-worker notification
pwd-huHungaryPosted-worker notification
pwd-ieIrelandPosted-worker notification
pwd-isIcelandPosted-worker notification
pwd-itItalyPosted-worker notification
pwd-liLiechtensteinPosted-worker notification
pwd-ltLithuaniaPosted-worker notification
pwd-luLuxembourgPosted-worker notification
pwd-lvLatviaPosted-worker notification
pwd-mtMaltaPosted-worker notification
pwd-nlNetherlandsPosted-worker notification
pwd-noNorwayPosted-worker notification
pwd-plPolandPosted-worker notification
pwd-ptPortugalPosted-worker notification
pwd-roRomaniaPosted-worker notification
pwd-seSwedenPosted-worker notification
pwd-siSloveniaPosted-worker notification
pwd-skSlovakiaPosted-worker notification
processKeys
travelerIds
array of numbers
required

IDs of the travelers to create a trip for — one trip is created per ID. Required; 1 to 500 positive integers.

travelerIds*
string
length ≤ 255

Optional identifier from an external system, stored against the created trip(s).

boolean
Defaults to false

Set to true to receive each created trip's completeness (the same result as POST /trips/{id}/completeness) in the response. Computed one trip at a time, so it adds latency; only honoured for up to 10 travelers — above that every completeness is null. Trips the request had no time left to check also come back null. For any null, call POST /trips/{id}/completeness.

Responses

400

A processKeys value is not a process key linked to your company (GET /processes lists them), or the list fails validation (more than 100 keys, duplicates, or a key longer than 64 characters).

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json