Add Driver
curl --request POST \
--url https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver \
--header 'AccessToken: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name_first": "John",
"name_last": "Doe",
"driver_license_state": "FL",
"driver_license_number": "F99900020",
"driver_date_of_birth": "1980-06-15",
"years_cdl_experience": 12,
"months_cdl_experience": 0,
"accidents_total": 0,
"suspensions_total": 0,
"violations_total": 0,
"major_violations_total": 0
}
'import requests
url = "https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver"
payload = {
"name_first": "John",
"name_last": "Doe",
"driver_license_state": "FL",
"driver_license_number": "F99900020",
"driver_date_of_birth": "1980-06-15",
"years_cdl_experience": 12,
"months_cdl_experience": 0,
"accidents_total": 0,
"suspensions_total": 0,
"violations_total": 0,
"major_violations_total": 0
}
headers = {
"AccessToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {AccessToken: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name_first: 'John',
name_last: 'Doe',
driver_license_state: 'FL',
driver_license_number: 'F99900020',
driver_date_of_birth: '1980-06-15',
years_cdl_experience: 12,
months_cdl_experience: 0,
accidents_total: 0,
suspensions_total: 0,
violations_total: 0,
major_violations_total: 0
})
};
fetch('https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name_first' => 'John',
'name_last' => 'Doe',
'driver_license_state' => 'FL',
'driver_license_number' => 'F99900020',
'driver_date_of_birth' => '1980-06-15',
'years_cdl_experience' => 12,
'months_cdl_experience' => 0,
'accidents_total' => 0,
'suspensions_total' => 0,
'violations_total' => 0,
'major_violations_total' => 0
]),
CURLOPT_HTTPHEADER => [
"AccessToken: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver"
payload := strings.NewReader("{\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"driver_license_state\": \"FL\",\n \"driver_license_number\": \"F99900020\",\n \"driver_date_of_birth\": \"1980-06-15\",\n \"years_cdl_experience\": 12,\n \"months_cdl_experience\": 0,\n \"accidents_total\": 0,\n \"suspensions_total\": 0,\n \"violations_total\": 0,\n \"major_violations_total\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("AccessToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver")
.header("AccessToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"driver_license_state\": \"FL\",\n \"driver_license_number\": \"F99900020\",\n \"driver_date_of_birth\": \"1980-06-15\",\n \"years_cdl_experience\": 12,\n \"months_cdl_experience\": 0,\n \"accidents_total\": 0,\n \"suspensions_total\": 0,\n \"violations_total\": 0,\n \"major_violations_total\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["AccessToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"driver_license_state\": \"FL\",\n \"driver_license_number\": \"F99900020\",\n \"driver_date_of_birth\": \"1980-06-15\",\n \"years_cdl_experience\": 12,\n \"months_cdl_experience\": 0,\n \"accidents_total\": 0,\n \"suspensions_total\": 0,\n \"violations_total\": 0,\n \"major_violations_total\": 0\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"driver_id": 123,
"submission_number": "<string>",
"transaction_id": 123
}Submission Data
Add Driver
Adds a driver to a submission or endorsement.
POST
/
submission
/
{displayId}
/
{transactionId}
/
driver
Add Driver
curl --request POST \
--url https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver \
--header 'AccessToken: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name_first": "John",
"name_last": "Doe",
"driver_license_state": "FL",
"driver_license_number": "F99900020",
"driver_date_of_birth": "1980-06-15",
"years_cdl_experience": 12,
"months_cdl_experience": 0,
"accidents_total": 0,
"suspensions_total": 0,
"violations_total": 0,
"major_violations_total": 0
}
'import requests
url = "https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver"
payload = {
"name_first": "John",
"name_last": "Doe",
"driver_license_state": "FL",
"driver_license_number": "F99900020",
"driver_date_of_birth": "1980-06-15",
"years_cdl_experience": 12,
"months_cdl_experience": 0,
"accidents_total": 0,
"suspensions_total": 0,
"violations_total": 0,
"major_violations_total": 0
}
headers = {
"AccessToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {AccessToken: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name_first: 'John',
name_last: 'Doe',
driver_license_state: 'FL',
driver_license_number: 'F99900020',
driver_date_of_birth: '1980-06-15',
years_cdl_experience: 12,
months_cdl_experience: 0,
accidents_total: 0,
suspensions_total: 0,
violations_total: 0,
major_violations_total: 0
})
};
fetch('https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name_first' => 'John',
'name_last' => 'Doe',
'driver_license_state' => 'FL',
'driver_license_number' => 'F99900020',
'driver_date_of_birth' => '1980-06-15',
'years_cdl_experience' => 12,
'months_cdl_experience' => 0,
'accidents_total' => 0,
'suspensions_total' => 0,
'violations_total' => 0,
'major_violations_total' => 0
]),
CURLOPT_HTTPHEADER => [
"AccessToken: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver"
payload := strings.NewReader("{\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"driver_license_state\": \"FL\",\n \"driver_license_number\": \"F99900020\",\n \"driver_date_of_birth\": \"1980-06-15\",\n \"years_cdl_experience\": 12,\n \"months_cdl_experience\": 0,\n \"accidents_total\": 0,\n \"suspensions_total\": 0,\n \"violations_total\": 0,\n \"major_violations_total\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("AccessToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver")
.header("AccessToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"driver_license_state\": \"FL\",\n \"driver_license_number\": \"F99900020\",\n \"driver_date_of_birth\": \"1980-06-15\",\n \"years_cdl_experience\": 12,\n \"months_cdl_experience\": 0,\n \"accidents_total\": 0,\n \"suspensions_total\": 0,\n \"violations_total\": 0,\n \"major_violations_total\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coverwhale.dev/v1/submission/{displayId}/{transactionId}/driver")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["AccessToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"driver_license_state\": \"FL\",\n \"driver_license_number\": \"F99900020\",\n \"driver_date_of_birth\": \"1980-06-15\",\n \"years_cdl_experience\": 12,\n \"months_cdl_experience\": 0,\n \"accidents_total\": 0,\n \"suspensions_total\": 0,\n \"violations_total\": 0,\n \"major_violations_total\": 0\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"driver_id": 123,
"submission_number": "<string>",
"transaction_id": 123
}Authorizations
AWS Cognito access token obtained from the /authentication endpoint. Token expires after 3600 seconds.
Headers
Body
application/json
Example:
"John"
Example:
"Doe"
Example:
"FL"
Example:
"F99900020"
Example:
"1980-06-15"
Y=Covered, N=Excluded
Available options:
Y, N Example:
12
Example:
0
Example:
0
Example:
0
Example:
0
Example:
0