Drivers

On this page, we'll dive into the different driver endpoints you can use to manage them programmatically.

The Driver object

Driver objects represent a single driver in a commercial or personal risk profile. They contain the following properties and relationships:

Global Properties

These properties are available for all risk profile types.

Name
number
Type
int
Filterable
Sortable
Description
The driver number
Name
employee_number
Type
nullable int
Sortable
Description
An employee number, also known as an employee ID or employee code, is a unique identifier for each employee in a company
Name
first_name
Type
nullable string
Filterable
Sortable
Description
The driver's first name
Name
middle_name
Type
nullable string
Filterable
Sortable
Description
The driver's middle name
Name
last_name
Type
nullable string
Filterable
Sortable
Description
The driver's last name
Name
date_of_birth
Type
nullable string
Description
The driver's date of birth
Name
is_employee
Type
bool
Filterable
Sortable
Description
Is the driver an employee of the company?
Name
is_contractor
Type
bool
Filterable
Sortable
Description
Is the driver a contractor for the company?
Name
license_number
Type
nullable string
Description
The driver's license number
Name
license_state
Type
nullable string
Filterable
Sortable
Description
TThe state in which the driver is licensed
Name
license_expiration
Type
nullable string
Filterable
Sortable
Description
The date the driver's license expires
Name
notes
Type
nullable string
Description
Any notes about the driver

Commercial-only Properties

These properties are available only for commercial risk profiles.

Name
hire_date
Type
nullable string
Description
The driver's hire date

Global Relations

Learn more about including relations.

Name
attachments
Type
Attachment[]
Name
attachments.uploader
Type
User
Description
The user who uploaded the attachment

GET/api/v1/risks/{risk}/data/drivers

List all drivers

This endpoint allows you to retrieve a paginated list of all drivers in the corresponding commercial or personal risk profile.

Parameters

See the driver object for a list of all available filters and sorts.

Searchable

You can search for drivers by providing a search query in the filter[search] parameter. The search query will be matched against driver first and last names.

Request

GET

/api/v1/risks/{risk}/data/drivers

curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/drivers \
-H "Authorization: Bearer {token}" \
-d filter[search]=Rich \
-d per_page=50

Response

{
    "data": [
        {
            "object": "driver",
            "uuid": "3d046100-8e94-48b4-8c1d-13d7527a030c",
            "data": {
                "number": 1,
                "employee_number": 1,
                "first_name": "Richard",
                "middle_name": "L",
                "last_name": "Hendricks",
                "date_of_birth": "06\/05\/1986",
                "hire_date": "02\/04\/2010",
                "is_employee": false,
                "is_contractor": false,
                "license_number": "CA-8J7Y9N3",
                "license_state": "CA",
                "license_expiration": "06\/05\/2030",
                "notes": null
            },
            "meta": {
                "created": "2024-04-24T18:37:15+00:00",
                "updated": "2025-02-04T15:19:54+00:00"
            }
        },
        {
            "object": "driver",
            "uuid": "580044c5-2c69-4ea2-b7dd-d29274dd0c3c",
            "data": {
                "number": 2,
                "employee_number": 2,
                "first_name": "Bertram",
                "middle_name": "F",
                "last_name": "Gilfoyle",
                "date_of_birth": "08\/25\/1981",
                "hire_date": "05\/05\/2015",
                "is_employee": false,
                "is_contractor": false,
                "license_number": "CA-5E6F7G8H",
                "license_state": "CA",
                "license_expiration": "08\/25\/2032",
                "notes": "Not Clean in Five"
            },
            "meta": {
                "created": "2024-04-24T18:37:15+00:00",
                "updated": "2025-02-04T15:21:02+00:00"
            }
        }
    ],
    "path": "https:\/\/app.wunderite.com\/api\/v1\/risks\/d10e34bb-4420-47de-ba9f-42a4a3f34b0e\/data\/drivers",
    "per_page": 50,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null
}

POST/api/v1/risks/{risk}/data/drivers

Create drivers

This endpoint allows you to create new drivers in the corresponding commercial or personal risk profile.

At least one driver object must be provided in the request body.

Optional global properties

See all available properties in the driver properties section.

Name
number
Type
nullable int
Description
The driver's number. When this property is not provided, or uses a null value, the driver will be assigned a number automatically.

Request

POST

/api/v1/risks/{risk}/data/drivers

curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/drivers" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "driver",
        "data": {
            "employee_number": "190389291",
            "first_name": "John",
            "last_name": "Doe",
            "date_of_birth": "1990-01-01",
            "hire_date": "2020-01-01",
            "is_employee": true,
            "is_contractor": false,
            "license_number": "CA123456",
            "license_state": "CA",
            "license_expiration": "2025-01-01",
            "notes": "This is a note"
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "driver",
            "uuid": "303626aa-d452-4392-8170-3da2a652f0e3",
            "data": {
                "number": 28,
                "employee_number": 190389291,
                "first_name": "John",
                "middle_name": null,
                "last_name": "Doe",
                "date_of_birth": "1990-01-01",
                "hire_date": "2020-01-01",
                "is_employee": true,
                "is_contractor": false,
                "license_number": "CA123456",
                "license_state": "CA",
                "license_expiration": "2025-01-01",
                "notes": "This is a note"
            },
            "meta": {
                "created": "2024-01-01T00:00:00+00:00",
                "updated": "2024-01-01T00:00:00+00:00"
            }
        }
    ]
}

PATCH/api/v1/risks/{risk}/data

Update drivers

This endpoint allows you to perform bulk updates on drivers.

At least one driver object must be provided in the request body. Each object must contain at least one property from the driver properties section.

Properties that are not provided will not be updated.

To clear a nullable property, provide a null value.

Request

PATCH

/api/v1/risks/{risk}/data

curl -X PATCH "https://app.wunderite.com/api/v1/risks/{risk}/data" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "driver",
        "uuid": "3d046100-8e94-48b4-8c1d-13d7527a030c",
        "data": {
            "number": 1,
            "employee_number": 1,
            "first_name": "Richard",
            "middle_name": "L",
            "last_name": "Hendricks",
            "date_of_birth": "06\/05\/1986",
            "hire_date": "02\/04\/2010",
            "is_employee": false,
            "is_contractor": false,
            "license_number": "CA-8J7Y9N3",
            "license_state": "CA",
            "license_expiration": "06\/05\/2030",
            "notes": null
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "driver",
            "uuid": "3d046100-8e94-48b4-8c1d-13d7527a030c",
            "data": {
                "number": 1,
                "employee_number": 1,
                "first_name": "Richard",
                "middle_name": "L",
                "last_name": "Hendricks",
                "date_of_birth": "06\/05\/1986",
                "hire_date": "02\/04\/2010",
                "is_employee": false,
                "is_contractor": false,
                "license_number": "CA-8J7Y9N3",
                "license_state": "CA",
                "license_expiration": "06\/05\/2030",
                "notes": null
            },
            "profile_type": "commercial"
        }
    ]
}

DELETE/api/v1/risks/{risk}/data

Delete drivers

This endpoint allows you to bulk delete risk data, including drivers.

At least one driver object must be provided in the request body to delete the corresponding driver.

Required properties

Name
object
Type
string
Description
The object type of the data to delete. Must be driver in this case
Name
uuid
Type
string
Description
The UUID of the driver to delete

Request

DELETE

/api/v1/risks/{risk}/data

curl -X DELETE "https://app.wunderite.com/api/v1/risks/{risk}/data" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "driver",
        "uuid": "3d046100-8e94-48b4-8c1d-13d7527a030c"
    }
]
}'

Response

{
    "data": [
        {
            "object": "driver",
            "uuid": "3d046100-8e94-48b4-8c1d-13d7527a030c",
            "profile_type": "commercial"
        }
    ]
}