NPS-LIC

From NP Tracker projects
Jump to navigation Jump to search

Note This is the developer's corner to aid in integrating our RESTfull API into their apps.


Interface

This is a REST API endpoint using HTTP GET.
Available to any device/server on the internet.

Usage

To use this endpoint you will need a valid API Key available after registration on NPS-CLOUD.
See our API documentation page for advance help and examples on using this endpoint.

Parameters

scan

The URI encoded text string of the Licence disk PDF-417 barcode.

vin

The 17 character VIN number to be tested.

token

This is your NPS-CLOUD account access token (API Key) available under the NPS-API menu in your NPS-CLOUD account.

Output

We provide a JSON formatted output of the results available from this API endpoint.
The barcode is encoded with data from the eNatis system linked to the vehicle.

NPS-LIC JSON output

VIN

The decoded barcode (Vehicle Identification Number) VIN number for the vehicle.

scan_plate

The decoded barcode Vehicle number plate (Licence plate) for the vehicle.

scan_manuf

The decoded barcode Vehicle manufacturer for the vehicle.

scan_model

The decoded barcode Vehicle manufacturer for the vehicle.

scan_class

The decoded barcode Vehicle class for the vehicle.

scan_eng

The decoded barcode Vehicle engine number for the vehicle.

scan_date

The decoded barcode Vehicle licence disk expiry date for the vehicle.

scan_type

We currently scan and decode the following barcode encoding formats:

  • MVL - Motor Vehicle Licence
  • RC - Registration Certificate.

pic_url

The VIN number is used to provide a image of the same vehicle make and model for visual confirmation by an operator.

manufacturer

The manufacturer linked in the propriaty NPS-VCR system.

plant

The manufacturer plant used to produce the vehicle linked in the propriaty NPS-VCR system.

brand

The manufacturer linked in the propriaty NPS-VCR system.

model

The vehicles model linked in the propriaty NPS-VCR system.

year

The vehicles manufacturers release/produced year linked to the VIN number of the vehicle.

engin_number

The vehicles engine number linked in the propriaty NPS-VCR system.

TokensLeft

The number of token credits left for your NPS-CLOUD account.

unlock

Returns a true and report if the user is allowed to inquire the drivers license details.
Return false if, for instance, the users token credits have run out.

checks

np_tracker

If true then there is a vehicle lookout report from the NP Tracker suspect and suspicious vehicle database linked to the vehicle, alternativly it will return false.

external

expired

If true then the date on the licence disk have expired, else false ie. disk is still valid.

manufacturer

If true then the scanned manufacturer and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.

model

If true then the scanned vehicle model and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.

engine

If true then the scanned vehicle engine number and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.

colour

If true then the scanned vehicle colour and the one we have on record for the vehicle based on the VIN is the same, alternatively it returns a false.