Difference between revisions of "NPS-DL"
(→User_IP) |
(→scan) |
||
| Line 17: | Line 17: | ||
=== Parameters === | === Parameters === | ||
==== scan ==== | ==== scan ==== | ||
| − | The HEX encoded | + | The HEX encoded string of the South African Drivers Licence (SADL) PDF-417 barcode.<br>This HEX string shall begin with 019b0945000025... |
==== token ==== | ==== token ==== | ||
Revision as of 10:12, 30 August 2022
 This is the developer's corner to aid in integrating our RESTfull API into their apps. |
Contents
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 HEX encoded string of the South African Drivers Licence (SADL) PDF-417 barcode.
This HEX string shall begin with 019b0945000025...
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.
User_IP
Clients IP address used to send the enquiry from.
EncryptionVersion
BarcodeVersion
Citizen
Initial
Surname
DOB
IDNo
IssuedBy
LicNo
Issued
ValidFrom
ValidTo
Code
Drivers licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types...
Licence1
The first licence vehicle code the driver may operate.
Licence2
The second licence vehicle code the driver may operate.
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.
Version
The version of the API endpoint.
