Date Topic Issue key Release Note
12/16/2024 VIN to vehicle reference code (VRC) endpoint API-174

Added a new endpoint to get the list of possible VRCs based on a vehicle VIN. This will return a list of possible VRC matches for one or more given VINs ordered by likelihood. Note that if we haven't seen this VIN pattern before (e.g. it's a new model year), or if we only have a limited data set, this data may not exist or may be inaccurate. If no results are found, an empty list will be returned.

Lookup VRC matches for a single VIN
Lookup VRC matches for multiple VINs

8/9/2024 Equipment endpoint API-75

Added associatedEquipment and bypassDetails arrays to the responses from the Equipment GET endpoint.

If the equipment is part of a package that includes multiple devices, the associatedEquipment array will give the type and equipmentNumber for each device in the package. For example, a Complete Pass would include two items in the associatedEquipment array, a BP Horizon and an NY E-ZPass.

The bypassDetails array includes any bypass provider identifiers for the equipment, if applicable. E.g. PrePass, NCPass, NORPass.
7/19/2024 Equipment Orders API-138 Added a new set of APIs for managing equipment orders (devices and transponders) under the /equipment-orders path. These APIs allow both retrieving (GET) and creating equipment orders (POST). There are several supplemental metadata retrieval calls to look up general configuration information related to equipment ordering: transponder types, shipping contacts, and shipping methods. The values from these lookups can then be passed in as needed to create equipment order calls.
7/16/2024 Vehicles endpoint API-151 Added a new optional boolean parameter deactivateEquipment to the vehicle deactivate endpoint: /vehicle/{unit}/deactivate. If deactivateEquipment is set to true, any equipment assigned to the vehicle at time of deactivation will also be deactivated. If false or not specified, equipment will be left active and can then be assigned to another vehicle (this remains compatible with the current behavior).
6/27/2024 Documentation API-152 Updated documentation to properly reflect the response body for ValidationProblemDetails error responses.
5/10/2024 Vehicles endpoint API-140 Improve handling for multiple vehicles with the same unit number. It is possible within Bestpass for the same unit number to be used for both the truck (PlateType = 'Standard') and the trailer (PlateType = 'Trailer'). All unit-specific vehicle endpoints /fleet-api/v1/vehicles/{unit} now accept an optional query parameter 'plateType' that can be passed to differentiate between the two in this case. If there is a duplicate and this parameter is not provided, 'Standard' will be preferred.
5/9/2024 Vehicles endpoint API-143 On vehicle create, if that license plate already exists on another customer account, you will now receive a 409 conflict error instead of 500 internal server error. Documentation for the Vehicle POST call has been updated to provide additional context on this scenario. This likely means the prior owner of the vehicle still has it registered for service with Bestpass. In this case, Bestpass support can assist in moving the vehicle over to your account.
4/26/2024 Cost centers endpoint API-133 Added the ability to create new cost centers via the POST cost centers endpoint
4/26/2024 Cost centers endpoint API-132 Added the ability to update cost centers via the PUT cost centers endpoint. There is also now a corresonding GET endpoint to retrieve a single cost center by name .
3/14/2024 Transactions endpoint API-50 Added the ability to search by transaction date (also known as exit date) rather than post date. To search by transaction date, pass transactionStartDate and transactionEndDate to the GET transactions endpoint. When searching for transactions you must supply either a post date range or a transaction date range. Both ranges are limited to a max of 31 days per request.
3/1/2024 General API-123 Rate limit increased from 60 requests per minute to 100 requests per minute.
2/7/2024 Transactions endpoint API-85 Added a new field ExitLocationState to the GET transactions endpoint. This contains the state code (e.g. NY) for the toll exit facility where the charge was incurred.
1/31/2024 Bug API-96 Fixed an issue where the location header in the 201 created response from a vehicle create did not include the correct URI to the newly created vehicle. Note that this did not impact the actual creation of the vehicle in any way.
10/27/2023 Bug API-97 Fixed an issue where a vehicle update with no field changes could result in termination of old record and creation of new record (vehicle swap). There is no impact to actual enrollment or assignment of toll charges from this, it could just make the data a bit noisier than intended.
10/23/2023 Violations endpoint API-92 Added a new API to submit violations for processing by Bestpass.
10/23/2023 Violations endpoint API-47 Added a new API to search and retrieve violations/citations.
10/23/2023 Permissions endpoint API-91 Updated permissions endpoint to properly return all accessible account numbers in the sandbox environment. In some cases this list was previously incomplete.
10/10/2023 Equipment endpoint API-53 Added the ability to backdate a device assignment to a vehicle by passing an options 'activeDate' to the assign equipment endpoint.
10/3/2023 Documentation API-81 Added additional documentation on possible error responses from create vehicle and assign equipment APIs.
8/25/2023 Documentation API-78 For clarity and visibility, Rate Limits set by Bestpass for use of the REST APIs were posted with high visibility. Note that exceeding the rate limits results in a 429 error clearly explained in the response.
8/24/2023 Vehicles endpoint API-79 An error was identified in the use of the Vehicles PUT when the vehicle was assigned to certain cost center numbers. This error was corrected.
8/24/2023 Transaction endpoint API-76 The speed of the Transactions GET endpoint was improved when large datasets were retrieved. The improvement reduces latency to roughly 1/12th of the original runtime.
8/24/2023 Bug API-74 Corrected a bug in the Equipment GET when ActiveOnly parameter is used. A request using Page 0 in the query resulted in a 500 rather than a Bad Request in the response.
7/21/2023 Equipment endpoint API-73 The Equipment GET endpoint was updated to offer a parameter of ActiveOnly, allowing customers to retrieve a list of all active transponders, omitting any that are inactive.
7/20/2023 Documentation API-70 Once you log into the API administration tool, customers have access to some plain language documentation about authorization and keys. The page was updated to provide clear information shown here: API subscriptions provide two access keys: a primary key and a secondary key. The secondary key is available to give you the ability to rotate keys without downtime.  If you want to change the primary key, you could swap to the secondary key, rotate the primary, then swap back.  This way you can coordinate the key changes in your system without requiring a hard cutover. We do not currently enforce any specific key rotation policy, so there’s no requirement to do key changes on any specified interval.  To get started, you can simply use the primary key.
7/14/2023 Equipment endpoint API-68 Once you log into the API administration tool, customers have access to some plain language documentation about authorization and keys. The page was updated to provide clear information shown here: API subscriptions provide two access keys: a primary key and a secondary key. The secondary key is available to give you the ability to rotate keys without downtime.  If you want to change the primary key, you could swap to the secondary key, rotate the primary, then swap back.  This way you can coordinate the key changes in your system without requiring a hard cutover. We do not currently enforce any specific key rotation policy, so there’s no requirement to do key changes on any specified interval.  To get started, you can simply use the primary key.
7/14/2023 Equipment endpoint API-62 The Equipment Unassign POST endpoint was updated to allow customers to provide a single ReasonCode (LOST). Including a ReasonCode with this value in the POST indicated to Bestpass that toll authorities should be notified that the transponder is no longer active and should not incur toll.
7/11/2023 Transactions endpoint API-55 Our first iteration of the REST API offered toll dates in UTC, which meant that clients needed to reverse engineer UTC to the local time of the event based on the timezone of the event. To make our API more friendly we added local date/time fields to the payload of the GET transactions endpoint
7/3/2023 Transaction endpoint API-63 The transactions GET endpoint was updated to allow a Cost Center as a query parameter. This makes it possible for customers to retrieve toll events one cost center at a time, rather than collecting all transactions and parsing them by cost center later.
6/30/2023 Documentation API-51 Prior to this release the API spec did not indicate the max limit for number of records per page that can be returned. Spec now notes the limit for each endpoint. It can differ by endpoint.
6/29/2023 Bug API-61 A bug affected customers that had a large number of cost centers. The bug prevented these customers from getting through the API authorization process to access endpoints.
6/20/2023 Transactions endpoint API-57 For a considerable percentage of toll events (not locations) Bestpass is able to provide GPS coordinates for the event. We estimate that we can offer this data for 95% of toll events. When available, coordinates are now exposed in the payload for the Transactions endpoint.
3/23/2023 Cost centers endpoint API-41 This enhancement allows the user of the Cost Centers GET endpoint to retrieve only those cost centers that are active by applying a ActiveOnly parameter.
2/24/2023 Vehicle endpoint API-67 A rule exists in the Vehicles POST endpoint: you may not submit a vehicle with a plate that already exists on another vehicle. The endpoint was simply updated to provide the conflicting vehicle’s info in the response when the rule is triggered. This allows customers to more easily troubleshoot the issue.
2/9/2023 Statements endpoint API-46 This enhancement allows the user of the statements endpoint to search for toll events by providing a Statement number as a parameter.