KEYSTONE API Standard
  1. Driver
KEYSTONE API Standard
  • Overview
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
  • Paths
    • Transport Operation
      • Create new transport operation data
      • Get all ongoing transport operation data
      • Get a specific transport operation data by ID
      • Update data for a specific transport operation by ID
      • Delete specific transport operation data by ID
      • Get schedule data related to a specific transport operation by ID
      • Update schedule data for a specific transport operation by ID
      • Get all phase data related to a specific transport operation by ID
      • Append phase data for a specific transport operation by ID
      • Get specific phase data by transport operation ID and phase ID
      • Update specific phase data by transport operation ID and phase ID
      • Get all international consignment notes related to a specific transport operation by ID
      • Append international consignment notes data for a specific transport operation by ID
      • Get specific international consignment notes data by transport operation ID and reference code
      • Update specific international consignment notes data by transport operation ID and reference code
      • Delete specific international consignment notes data by transport operation ID and reference code
      • Get ongoing transport operation data by country code and license plate number
      • Get details about the schedule of the ongoing transport operation by country code and license plate number
      • Get details about all the phases of the ongoing transport operation by country code and license plate number
      • Get specific phase data related to the ongoing transport operation by country code, license plate number, and phase ID
      • Get all international consignment notes related to the ongoing transport operation by country code and license plate number
      • Get specific international consignment notes data related to the ongoing transport operation by country code, license plate number, and reference code
      • Get all locations related to transport operations
      • Get all locations related to transport operations by location mode
    • Vehicle
      • Create new vehicle data
      • Get all vehicle data
      • Get vehicle data by country code and license plate number
      • Update vehicle data by country code and license plate number
      • Delete specific vehicle data by country code and license plate number
      • Get details about the geolocation of vehicle by country code and license plate number
      • Append new vehicle's geolocation data by country code and license plate number
      • Get details about the owner of vehicle by country code and license plate number
      • Get details about the insurances of vehicle by country code and license plate number
      • Get details about the insurance of vehicle by country code, license plate number and insurance id
      • Get details about the revisions of vehicle by country code and license plate number
      • Get details about the revision of vehicle by country code, license plate number and revision id
    • Driver
      • Create new driver data
        POST
      • Get all driver data
        GET
      • Get driver data by country code and vat number
        GET
      • Update driver data by country code and vat number
        PUT
      • Delete specific driver data
        DELETE
      • Get details about the driver's license by country code and vat number
        GET
      • Get details about the driver's traffic violations by country code and vat number
        GET
      • Get specific driver's traffic violation data by country code, vat number and traffic violation id
        GET
      • Get details about the driver's tachograph cards data by country code and vat number
        GET
      • Get specific driver's tachograph card data by country code, vat number and tachograph card id
        GET
  1. Driver

Get details about the driver's license by country code and vat number

GET
https://api.company-server/v1/drivers/{countryCode}/{vat}/licenses/
Driver

Request

Path Params
countryCode
string 
required
Country code of the vehicle's registration.
Match pattern:
^[A-Z]{2,4}$
vat
string 
required
Vat number of the driver.
Match pattern:
^[\s\S]{2,13}$

Responses

🟢200OK
application/json
License data retrieved successfully
Body
Details of the driver's license.
id
string 
required
License unique identifier, which could be set as corresponding to the actual EU Licence Number.
Example:
IT1234567890
Match pattern:
^[A-Z0-9]{1,16}$
countryCode
string 
required
Country code of the driver's license.
Example:
IT
Match pattern:
^[A-Z]{2,4}$
category
array[object (Category) {6}] 
required
List of diverse license's categories.
type
enum<string> 
required
License type.
Allowed values:
AMAA1A2BBEB1C1C1ECCED1D1EDDE
Example:
C
description
string 
optional
A description of the vehicle type associated with the license category.
Example:
Goods Vehicle
Match pattern:
^[\s\S]{1,20}$
issueDate
string <date>
required
The date when the license was issued.
Example:
2020-01-01
Match pattern:
^\d{4}-\d{2}-\d{2}$
expiryDate
string <date>
required
The date when the license is set to expire.
Example:
2025-12-31
Match pattern:
^\d{4}-\d{2}-\d{2}$
status
enum<string> 
required
Status of the license.
Allowed values:
VALIDEXPIREDSUSPENDEDREVOKEDCONFISCATEDLOST/STOLEN
Example:
VALID
code95
string 
optional
Certificate of Professional Competence (CPC) qualification.
Example:
95 (13.02.25)
Match pattern:
^[\s\S]{1,20}$
Example
{
    "id": "IT1234567890",
    "countryCode": "IT",
    "category": [
        {
            "type": "B",
            "issueDate": "2015-01-01",
            "expiryDate": "2025-12-31",
            "status": "VALID"
        },
        {
            "type": "C",
            "issueDate": "2020-01-01",
            "expiryDate": "2025-12-31",
            "status": "VALID",
            "code95": "95 (13.02.25)"
        }
    ]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Previous
Delete specific driver data
Next
Get details about the driver's traffic violations by country code and vat number
Built with