Skip to main content
POST
Initiate a trip participant background check

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

tripId
integer
required

Trip ID belonging to the authenticated organization.

id
integer
required

Record ID within the organization and any parent resource in this route.

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

package
string
required

Validation: required|string|max:255.

Maximum string length: 255
work_location_ids
string[] | null
Maximum string length: 255
cost_mode
enum<string> | null

Validation: nullable|in:org,organization,participant,candidate.

Available options:
org,
organization,
participant,
candidate,
null
Example:

"org"

reuse_existing
boolean | null

Validation: nullable|boolean.

Example:

false

force_new
boolean | null

Validation: nullable|boolean.

Example:

false

Response

Initiate a trip participant background check response.

data
object