Skip to main content
POST
Add Driver

Authorizations

Authorization
string
header
required

Client API key sent as a bearer token.

X-Client-Directory
string
header
required

Client directory identifier. Legacy directory header is still accepted for backward compatibility.

Body

application/json
surname
string
required

Driver surname.

Maximum string length: 64
Example:

"Kowalski"

name
string
required

Driver first name.

Maximum string length: 64
Example:

"Jan"

phone
string | null

Driver phone number.

Maximum string length: 32
Example:

"+48 123 456 789"

id_number
string | null

Identification document number.

Maximum string length: 64
Example:

"ABC123456"

employment
string | null

Employment type or description.

Maximum string length: 32
Example:

"Employment contract"

permitted_countries
string[] | null

Country codes in which the driver is permitted to operate.

Maximum string length: 8
Example:
license_category
string | null

Driving licence category.

Maximum string length: 16
Example:

"C+E"

driver_license_number
string | null

Driving licence number.

Maximum string length: 16
Example:

"12345/26"

driver_card_id
string | null

Driver card identifier.

Maximum string length: 32
Example:

"PL1234567890"

trainee
boolean | null
default:false

Marks the driver as a trainee.

adr
boolean | null
default:false

Indicates that the driver has ADR qualifications.

avsec
boolean | null
default:false

Indicates that the driver has AVSEC qualifications.

gdp
boolean | null
default:false

Indicates that the driver has GDP qualifications.

tapa
boolean | null
default:false

Indicates that the driver has TAPA qualifications.

Response

Driver created successfully.

status
integer
required
Example:

201

message
string
required
Example:

"Created"

data
object
required