Difference between revisions of "NPS-DLNAM"
(→Checks) |
(→Usage) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 12: | Line 12: | ||
== Usage == | == Usage == | ||
To use this endpoint you will need a valid [[API Key]] available after registration on [[NPS-CLOUD]].<br> | To use this endpoint you will need a valid [[API Key]] available after registration on [[NPS-CLOUD]].<br> | ||
| − | See our [https://api.nptracker.co.za/docs API documentation page] for advanced help and examples on using this endpoint. | + | See our [https://api.nptracker.co.za/docs/ API documentation page] for advanced help and examples on using this endpoint. |
| Line 29: | Line 29: | ||
=== Name === | === Name === | ||
| − | Driver's full name | + | Driver's full name. |
=== Surname === | === Surname === | ||
| − | Driver's surname | + | Driver's surname. |
=== DOB === | === DOB === | ||
| − | Driver's date of birth | + | Driver's date of birth. |
=== IDNo === | === IDNo === | ||
| − | Driver's ID Number | + | Driver's ID Number. |
=== IssuedBy === | === IssuedBy === | ||
| − | Issued state | + | Issued state in ISO format. |
=== LicNo === | === LicNo === | ||
| − | + | Driver's licence number. | |
=== Issued === | === Issued === | ||
| − | Date the card was first issued | + | Date the card was first issued. |
=== ValidFrom === | === ValidFrom === | ||
| − | Date the card was issued/renewed | + | Date the card was issued/renewed. |
=== ValidTo === | === ValidTo === | ||
| − | Date the licence will expire | + | Date the licence will expire. |
=== Code === | === Code === | ||
Driver's licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types... | Driver's licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types... | ||
| Line 58: | Line 58: | ||
Current token credits left for the API account. | Current token credits left for the API account. | ||
=== Checks === | === Checks === | ||
| + | Addition checks based on data in the decrypted barcode. | ||
==== VehRestr ==== | ==== VehRestr ==== | ||
| − | Not enough data to decode this currently returning "-" | + | Not enough data to decode this currently returning "-". |
==== UserRestr ==== | ==== UserRestr ==== | ||
| − | Not enough data to decode this currently returning "-" | + | Not enough data to decode this currently returning "-". |
==== expired ==== | ==== expired ==== | ||
| − | The boolean value will be false if ValidTo date is past today's date else return true | + | The boolean value will be false if ValidTo date is past today's date else return true. |
==== age ==== | ==== age ==== | ||
| − | The driver's age based on his ID number | + | The driver's age is based on his ID number. |
==== gender ==== | ==== gender ==== | ||
| − | The driver's gender is based on his ID number | + | The driver's gender is based on his ID number. |
Latest revision as of 09:35, 31 May 2023
 This is the developer's corner to aid in integrating our RESTful 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 advanced help and examples on using this endpoint.
Parameters
scan
The HEX encoded string of the Namibia Drivers Licence (SADL) PDF-417 barcode.
This HEX string shall begin with A000000248010002...
Please see our example application on | GitHub for an example of how to convert from the PDF417 decoded binary format scan to the expected HEX value.
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
Client's IP address that was used to send the enquiry from.
Name
Driver's full name.
Surname
Driver's surname.
DOB
Driver's date of birth.
IDNo
Driver's ID Number.
IssuedBy
Issued state in ISO format.
LicNo
Driver's licence number.
Issued
Date the card was first issued.
ValidFrom
Date the card was issued/renewed.
ValidTo
Date the licence will expire.
Code
Driver's licence vehicle codes the driver is allowed to operate. ie Bike & car/truck types...
Licence1
The first licence vehicle code the driver may operate.
Unlock
Returns a true report if the user is allowed to inquire the drivers license details.
Return false if, for instance, the user's token credits have run out.
Version
The version of the API endpoint.
TokensLeft
Current token credits left for the API account.
Checks
Addition checks based on data in the decrypted barcode.
VehRestr
Not enough data to decode this currently returning "-".
UserRestr
Not enough data to decode this currently returning "-".
expired
The boolean value will be false if ValidTo date is past today's date else return true.
age
The driver's age is based on his ID number.
gender
The driver's gender is based on his ID number.
