POST
/
analyze
/
title
curl --request POST \
  --url https://dev.cardinalgray.com/analyze/title \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "vin": "<string>",
  "name": "<string>"
}'
{
  "id": "<string>",
  "status": "pending"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
Encoded image data and optional identification
​
title
file
required

Base64 Encoding of a JPEG image of the front of the vehicle's title

​
vin
string

Optional. Checks the vehicle identification number held in the caller's system against the VIN listed on the title.

​
name
string

Optional. Checks the owner's name against the owner listed on the title.

Response

200
application/json
Task initiated and image data accepted
​
id
string

Unique identifier for the title analysis task

​
status
enum<string>

Current status of the task

Available options:
pending,
failure,
complete
Title Analysis