POST
/
analyze
/
packet
curl --request POST \
  --url https://dev.cardinalgray.com/analyze/packet \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "file": {
    "url": "<string>"
  },
  "vehicle_type": "AUTO",
  "transfer_type": "NEW",
  "state": "AL"
}'
{
  "jobId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
file
object
required
​
vehicle_type
enum<string>

Type of vehicle being titled/registered

Available options:
AUTO,
OHV,
MOTORCYCLE,
TRAILER,
BOAT
​
transfer_type
enum<string>

Type of ownership transfer

Available options:
NEW,
USED,
GIFT,
FLOORPLAN
​
state
enum<string>

State where the transaction is taking place

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DC,
DE,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY

Response

200
application/json
Successfully initiated packet analysis
​
jobId
string

Unique identifier for tracking the analysis job

Title AnalysisAnalyze Packet