post

/immobilizations

This endpoint should be used when the device is being deployed to immobilize a vehicle. It will create a trackable record in Passport’s system and associate appropriate outstanding citations to the immobilization record.

Once complete, vehicle owners can search for and pay outstanding citations within Passport’s payment system.

Request Parameters

2 Headers

Request Body

  • Arrays of image URLs within the attachments array
Schema
object
attachments
array[string]
boot_type
string

This determines the type of immobilization that needs to be applied within the Passport system.

Accepted values will be provided by Passport as it relates to your integration.

required
deployment_id
string

External deployment ID

1 validation + required
device_id
string

An externally provided ID that represents the device used in the immobilization.

1 validation + required
device_number
string

An externally provided serial number that represents the device used in the immobilization.

1 validation + required
lpn
string

Vehicle license plate number

1 validation + required
operator_id
string

UUID identifier used to identify a Passport client.

1 validation + required
plate_type
string

Vehicle license plate type

1 validation
release_code
string

This is the code that should be displayed after the citations associated to an immobilization have been paid to unlock the device.

1 validation
state
string

Vehicle license plate state

1 validation + required

Responses

This response indicates the resource was created successfully.

1 Header
Schema
object
citations
array[object]
id
string

The internal ID of the Passport immobilization record.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host