The Passport immobilization API provides a way to register an immobilization device that has been applied to a vehicle. This would be completed after the vehicle has received multiple parking violations and is deemed eligible to receive such a device that would require all outstanding violations to be paid. These APIs provide a standard interface to create immobilization records and lookup quotes that return back the total outstanding amount of fees related to violations issued to an immobilized vehicle.
An immobilization record within Passport’s system can transition linearly through several status depending on the actions taken by an enforcement officer applying an immobilization, the citation recipient paying outstanding violations, and the immobilization device being returned to the client.
Identifying Outstanding Vehicles
You can use the Retrieve a quote API and provide a variety of filters to search for a vehicle within the Passport system. This API will return back a value of all oustanding citations that represent the outstanding balance that is due.
After an immobilization device has been applied to a vehicle, you should create an immobilization record in the Passport system using the Create an immobilization API. Once an immobilization has been created for a vehicle, Passport will automatically assign a payable immobilization fee that can be paid within the Passport system.
Once you have registered an immobilization device against a vehicle, the immobilization will be in the
Deployed status. After all citations have been paid along with the immobilization fee, the immobilization record will transition to the
If you have an smart device that is used in the immobillization process and would like to discuss options where Passport is able to automatically unlock the immobilization after all citations have been paid, please reach out to your contacts at Passport and we can explore additional capabilities.
After an immobilization device has been removed from the vehicle and is returned, you will need to update the Passport system using the Update an existing immobilization API. Failing to update the Passport system may result in an late return fee being accessed against the vehicle which can result in additional fines. After an immobilization has been updated, the status of that immobilization will be
If you have deployed an immobilization device to a vehicle and would like to reverse this decision, you may use the Delete an existing immobilization API. This should not be used to mark an immobilization as being returned and should only be used if an immobilization device was placed on a vehicle and needs to be removed before any action is taken by the vehicle owner.
Partner Managed APIs
To maximize the value of an integration with Passport’s immobilization services, there are several API resources you will need to develop and make available. These are outlined below for your reference. We will work with you to confirm any details of your implementation and review compatibility as needed.
When our system is connecting to your application, we are able to authenticate with either a traditional API key that is provided with each request or we can generate an access token using the standard OAuth 2.0 client credentials flow.
Access Token Creation
If you would like for us to generate an access token using the OAuth model, we will need an endpoint available that we can
POST to. The response must provide an
access_token in the body of the response as defined by the standardized specifications.
If you would like to provide an API key you do not need to release an endpoint for
access_token generation and this can be provided to your point-of-contacts at Passport.
Retrieve Device Release Code API
If an immobilization device’s release code was not provided when the POST …/immobilization was made, or provided subsequently through a PATCH …/immobilization request, Passport will need to make a request to your system when all citations have been paid to retrieve this code.
We are able to submit either a
GET or a
POST request to an API endpoint you manage and provide an
immobilization_id and a
device_id value. Since both of these values will be provided, you will have the flexibility of choosing which field will be a better fit for your application’s implementation. The response body of this request should contain a JSON object which includes a string value with the key of
Retrieve Device Status API
After the related citations have been paid and an immobilization device has been removed from a vehicle, Passport is able to assess a “lost-device fee” after a pre-determined period if the immobilization record does not reflect that the device was returned. This provides our customers the ability to recover the capital that is required to maintain an inventory of immobiliztion devices.
Before Passport will process the lost device fee to the customer who removed the device but is responsible for the device not being returned, we must validate the device’s status in your system. This validation can be completed by us making a
GET request to an API that you manage where the response body contains a JSON object which includes a string value with the key of
status. One of the following values are expected to be returned: