Skip to main content
POST
/
submission
/
{displayId}
/
{transactionId}
/
vehicle
Add Vehicle
curl --request POST \
  --url https://app.coverwhale.com/api/v1/submission/{displayId}/{transactionId}/vehicle \
  --header 'AccessToken: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vehicle_id_number": "<string>",
  "year": 2020,
  "make": "FREIGHTLINER",
  "model": "CASCADIA",
  "class": "<string>",
  "value": 45000,
  "body_type": "<string>",
  "deductible": 123
}
'
{
  "status": "success",
  "vehicle_id": 123,
  "submission_number": "<string>",
  "transaction_id": 123
}

Authorizations

​
AccessToken
string
header
required

AWS Cognito access token obtained from the /authentication endpoint. Token expires after 3600 seconds.

Headers

​
AccessToken
string
required

Path Parameters

​
displayId
string
required
​
transactionId
integer
required

Body

application/json
​
vehicle_id_number
string
required

VIN (10-17 chars)

​
year
integer
required
Example:

2020

​
make
string
required
Example:

"FREIGHTLINER"

​
model
string
required
Example:

"CASCADIA"

​
class
string
required

Vehicle class key

​
value
integer
required
Example:

45000

​
body_type
string

Body type key

​
deductible
integer

Custom deductible override

Response

Vehicle added

​
status
string
Example:

"success"

​
vehicle_id
integer
​
submission_number
string
​
transaction_id
integer