Skip to main content
GET
/
title
List title entries or search by parameters
curl --request GET \
  --url https://dev.cardinalgray.com/title \
  --header 'Authorization: Bearer <token>'
{
  "webhook_events": [
    "<string>"
  ],
  "website": "<string>",
  "entryId": "<string>",
  "userId": "<string>",
  "user_email": "<string>",
  "job_status": "pending",
  "groupId": "<string>",
  "s3Index": "<string>",
  "last_modified": 123,
  "VIN": "<string>",
  "state": "<string>",
  "Borrower": "<string>",
  "existingEntryId": "<string>",
  "bdaJobs": {},
  "attachment": [
    {
      "display_name": "<string>",
      "s3_key": "<string>",
      "document_type": "VEHICLE_TITLE",
      "json_path": "<string>"
    }
  ],
  "lmsData": {},
  "loanData": "<any>",
  "account_data": {
    "vehicle": {
      "vin": "1HGCM82633A123456",
      "year": 2023,
      "make": "Honda",
      "model": "Accord",
      "body": "<string>",
      "type": "AUTO",
      "color": "<string>",
      "color_secondary": "<string>",
      "fuel_type": "<string>",
      "use": "<string>",
      "weight": "<string>",
      "weight_rating": "<string>",
      "weight_gross": "<string>",
      "weight_unladen": "<string>",
      "width": "<string>",
      "length": "<string>",
      "bhpcc": "<string>",
      "number_of_axles": "<string>",
      "number_of_cylinders": "<string>",
      "license_plate": "<string>",
      "license_plate_type": "<string>",
      "motorcycle_engine_number": "<string>",
      "registration_status": "ACTIVE",
      "registration_expiration_date": "<string>",
      "class": "<string>",
      "has_reg_title_holds": true,
      "reg_title_holds": [
        "<any>"
      ],
      "prev_date_of_sale": "<string>",
      "fee_history": [
        "<any>"
      ],
      "insurance": {},
      "title": {}
    },
    "loan": {
      "new_lienholder": {
        "id": "<any>",
        "type": "LIENHOLDER",
        "name": "<any>",
        "oats_names": "<any>",
        "addr": "<any>",
        "contact_phone": "<any>",
        "contact_email": "<any>",
        "address_vault": {},
        "elt_id": "<string>",
        "feid": "<string>",
        "signatory": {}
      },
      "borrower": [
        {}
      ],
      "loan_id": "<string>",
      "security_agreement_sign_date": "<string>",
      "loan_amount": 123,
      "payoff_amount": 123,
      "per_diem": 123,
      "prior_lien": {
        "lien_date": "<any>",
        "lien_amount": "<any>",
        "lien_id": "<any>",
        "lienholder": "<any>"
      },
      "add_owner": [
        {}
      ],
      "drop_owner": [
        {}
      ],
      "release_title_to_address": {
        "recipient_name": "<string>",
        "street1": "<string>",
        "street2": "<string>",
        "city": "<string>",
        "county": "<string>",
        "state": "<string>",
        "zip": "<string>"
      }
    },
    "sale": {
      "type": "NEW",
      "sale_price": 123,
      "date_of_sale": "<string>",
      "state": "<string>",
      "seller": {
        "id": "<any>",
        "type": "PERSON",
        "name": "<any>",
        "oats_names": "<any>",
        "addr": "<any>",
        "contact_phone": "<string>",
        "contact_email": "<string>",
        "dob": "<string>",
        "dlid": {},
        "ssn": "<string>",
        "addr_mailing": {},
        "insurance": {},
        "ownership_type": "<string>",
        "is_nonobligor": true
      },
      "buyer": [
        {}
      ],
      "financed": {
        "lien_date": "<any>",
        "lien_amount": "<any>",
        "lien_id": "<any>",
        "lienholder": "<any>"
      },
      "delivery_date": "<string>",
      "additional_dues": {
        "fidelity": "initial",
        "deliveryEstimate": 123,
        "taxEstimates": [
          "<any>"
        ],
        "feeEstimates": [
          "<any>"
        ]
      },
      "trade_in": {
        "vin": "1HGCM82633A123456",
        "year": 2023,
        "make": "Honda",
        "model": "Accord",
        "body": "<string>",
        "type": "AUTO",
        "color": "<string>",
        "color_secondary": "<string>",
        "fuel_type": "<string>",
        "use": "<string>",
        "weight": "<string>",
        "weight_rating": "<string>",
        "weight_gross": "<string>",
        "weight_unladen": "<string>",
        "width": "<string>",
        "length": "<string>",
        "bhpcc": "<string>",
        "number_of_axles": "<string>",
        "number_of_cylinders": "<string>",
        "license_plate": "<string>",
        "license_plate_type": "<string>",
        "motorcycle_engine_number": "<string>",
        "registration_status": "ACTIVE",
        "registration_expiration_date": "<string>",
        "class": "<string>",
        "has_reg_title_holds": true,
        "reg_title_holds": [
          "<any>"
        ],
        "prev_date_of_sale": "<string>",
        "fee_history": [
          "<any>"
        ],
        "insurance": {},
        "title": {}
      }
    },
    "repo": {
      "reposession_date": "<string>",
      "reposession_address": {
        "recipient_name": "<string>",
        "street1": "<string>",
        "street2": "<string>",
        "city": "<string>",
        "county": "<string>",
        "state": "<string>",
        "zip": "<string>"
      },
      "reposession_agency": "<string>",
      "reposession_agency_address": {
        "recipient_name": "<string>",
        "street1": "<string>",
        "street2": "<string>",
        "city": "<string>",
        "county": "<string>",
        "state": "<string>",
        "zip": "<string>"
      }
    },
    "salvage": {
      "type": "THEFT",
      "insurance": {
        "provider_name": "<string>",
        "provider_naic": "<string>",
        "policy_number": "<string>"
      },
      "claim_number": "<string>",
      "total_loss_date": "<string>",
      "payoff_date": "<string>"
    }
  },
  "account_status": "originated",
  "is_elt": true,
  "elt_data": {
    "id": "<string>",
    "ddi_email": "<string>",
    "receipt_lien_perfection": "<string>",
    "receipt_lien_release": "<string>",
    "receipt_lien_release_complete": "<string>",
    "messages": [
      {
        "message": {},
        "resolved": true
      }
    ]
  },
  "lenderLoanId": "<string>",
  "tracking_url_provider": "<string>",
  "form_lien_add": "<string>",
  "form_title_application": "<string>",
  "form_duplicate_title": "<string>",
  "form_repo_affidavit": "<string>",
  "form_lien_release_letter": "<string>",
  "forms_poa": [
    {
      "signer_id": "<string>",
      "signer_name": "<string>",
      "form": "<string>",
      "form_generic": "<string>"
    }
  ],
  "form_payoff_authorization": "<string>",
  "form_letter_of_guarantee": "<string>",
  "form_final_packet": "<string>",
  "final_packet_indices": "<string>",
  "form_instructions": "<string>",
  "form_ohv_declaration": "<string>",
  "form_odometer_disclosure": "<string>",
  "form_addr_oats": "<string>",
  "form_vin_verification": "<string>",
  "form_low_speed_affidavit": "<string>",
  "forms_name_oats": [
    {
      "signer_id": "<string>",
      "signer_name": "<string>",
      "form": "<string>",
      "form_generic": "<string>"
    }
  ],
  "forms_non_obligor": [
    {
      "signer_id": "<string>",
      "signer_name": "<string>",
      "form": "<string>",
      "form_generic": "<string>"
    }
  ],
  "form_updates": {},
  "form_downloads": {},
  "nmvtis_txn_id": "<string>",
  "nmvtis_pull": "<string>",
  "nmvtis_found_status": "<string>",
  "nmvtis_report_pdf": "<string>",
  "nmvtis_last_fetch": "<string>",
  "state_txn_id": "<string>",
  "state_pull": "<string>",
  "state_found_status": "<string>",
  "state_report_pdf": "<string>",
  "state_last_fetch": "<string>",
  "portal_screenshot": "<string>",
  "portal_pull": "<string>",
  "portal_found_status": "<string>",
  "portal_last_fetch": "<string>",
  "insurance_last_fetch": "2023-11-07T05:31:56Z",
  "insurance_search_raw_data": {},
  "insurance_search_result": "<string>",
  "insurance_update_result": "<string>",
  "signature_requests": [
    {
      "redirect_url": {
        "url": "<string>",
        "message": "<string>"
      },
      "requester_email": "<string>",
      "id": "<string>",
      "type": "WET_SIGN",
      "status": "DRAFT",
      "documents_to_sign": [
        {}
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "signers": [
        {}
      ],
      "sign_cert": "<string>",
      "collected_dlid": "<string>",
      "full_export": "<string>",
      "physical_tracking": {
        "status": "<string>",
        "tracking_url": "<string>",
        "label_url": "<string>",
        "shipment_id": "<string>",
        "return_tracking_url": "<string>",
        "return_label_url": "<string>",
        "return_shipment_id": "<string>"
      },
      "instructions": "<string>",
      "metadata": {}
    }
  ],
  "fee_estimate": {
    "tax": {
      "taxable_amount": 123,
      "total": 123,
      "items": [
        {}
      ],
      "submission_instructions": {
        "payable_to": "<string>",
        "address": {}
      }
    },
    "registration": {
      "total": 123,
      "items": [
        {}
      ]
    },
    "title": {
      "total": 123,
      "items": [
        {}
      ]
    },
    "submission_instructions": {
      "payable_to": "<string>",
      "address": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
vin
string

Vehicle Identification Number (vin) to search for. Returns a single matching entry if found. Must be exactly 17 characters.

Example:

"1HGBH41JXMN109186"

​
state
string

Filter entries by a specific US state

​
timeline
integer

Filter entries modified within this many milliseconds from now (e.g., 86400000 for last 24 hours)

Required range: x >= 1
Example:

86400000

​
account_status
enum<string>

Filter entries by account status in the title workflow

Available options:
originated,
poa_sent,
poa_signed,
filing_en_route,
filing_received,
lien_delay,
lien_error,
lien_filed,
lien_perfected,
account_paid,
lien_release_pending,
lien_release_complete
​
limit
integer

Maximum number of entries to return for pagination

Required range: 1 <= x <= 1000
Example:

50

​
nextToken
string

Pagination token from previous response to get next page of results

​
groupId
string

Filter entries by specific group ID

Response

Successful response with different formats based on query parameters

  • Option 1
  • Option 2

Single title entry (returned when using ?vin parameter)

​
website
string
required

Organization identifier

​
entryId
string
required

Unique identifier for this database entry

​
userId
string
required

User who created this entry

​
VIN
string
required

Vehicle Identification Number (17 characters)

​
state
string
required

State where the vehicle is titled/registered

​
account_data
object
required
​
webhook_events
string[]

Only exists on sent webhooks to help users quickly parse specific fields

​
user_email
string

Email of the user who created this entry

​
job_status
enum<string>

Processing status of the title entry workflow. Statuses: 'pending' - Initial state when job is created; 'input_parsing' - Processing uploaded documents and extracting data; 'enriching' - Enriching data with NMVTIS/DMV data or calculating fees; 'generating_forms' - Generating DMV forms for submission; 'complete' - Successfully completed all processing; 'error' - Error state for any processing failures

Available options:
pending,
input_parsing,
enriching,
generating_forms,
complete,
error
​
groupId
string

User group ID for organizational access control

​
s3Index
string

S3 path prefix for this entry's documents

​
last_modified
number

Timestamp when this entry was last modified

​
Borrower
string

Primary borrower name on the loan

​
existingEntryId
string

If this is a duplicate entry, points to the original entry ID

​
bdaJobs
object

Background document analysis job statuses

​
attachment
object[]

User-uploaded documents like driver licenses, vehicle titles, etc.

​
lmsData
object

Loan management system data

​
loanData
any

Legacy loan data field (can be any type or AccountData)

​
account_status
enum<string>

Current status of the account in the titling/lien workflow. Early stages: 'originated' - Account created; 'poa_sent' - Power of Attorney sent to customer; 'poa_signed' - POA signed and returned. DMV submission: 'filing_en_route' - Documents in transit to DMV; 'filing_received' - DMV received documents. Lien lifecycle: 'lien_delay' - Lien processing delayed; 'lien_error' - Error in lien filing; 'lien_filed' - DEPRECATED; 'lien_perfected' - Lien successfully perfected. End of life: 'account_paid' - Account paid off; 'lien_release_pending' - Lien release in progress; 'lien_release_complete' - Lien fully released

Available options:
originated,
poa_sent,
poa_signed,
filing_en_route,
filing_received,
lien_delay,
lien_error,
lien_filed,
lien_perfected,
account_paid,
lien_release_pending,
lien_release_complete
​
is_elt
boolean

Whether this account uses Electronic Lien & Title system

​
elt_data
object
​
lenderLoanId
string

Lender's internal loan/account number

​
tracking_url_provider
string

Service provider for shipping tracking (if applicable)

​
form_lien_add
string

S3 path to the Add Lien form PDF

​
form_title_application
string

S3 path to the Title Application form PDF

​
form_duplicate_title
string

S3 path to the Duplicate Title request form PDF

​
form_repo_affidavit
string

S3 path to the Repossession Affidavit PDF

​
form_lien_release_letter
string

S3 path to the Lien Release Letter PDF

​
forms_poa
object[]

Array of Power of Attorney forms

​
form_payoff_authorization
string

S3 path to the Payoff Authorization form PDF

​
form_letter_of_guarantee
string

S3 path to the Letter of Guarantee PDF

​
form_final_packet
string

S3 path to the Final Packet PDF (contains all generated forms combined)

​
final_packet_indices
string

Page indices showing which forms appear on which pages of the final packet

​
form_instructions
string

S3 path to the Instructions PDF

​
form_ohv_declaration
string

S3 path to the Off-Highway Vehicle Declaration PDF

​
form_odometer_disclosure
string

S3 path to the Odometer Disclosure form PDF

​
form_addr_oats
string

S3 path to the Address OATS form PDF

​
form_vin_verification
string

S3 path to the VIN Verification form PDF

​
form_low_speed_affidavit
string

S3 path to the Low Speed Vehicle Affidavit PDF

​
forms_name_oats
object[]

Array of Name OATS forms

​
forms_non_obligor
object[]

Array of Non-Obligor forms

​
form_updates
object

Mapping of DynamoDBEntry.form* key to s3 metadata.json file containing overview of form updates

​
form_downloads
object

Mapping of DynamoDBEntry.form* key to download count

​
nmvtis_txn_id
string

Transaction ID for NMVTIS vehicle history report

​
nmvtis_pull
string

S3 URL to JSON file containing the NMVTIS pull results as AccountData

​
nmvtis_found_status
string

Whether NMVTIS found records: 'found' or 'not_found'

​
nmvtis_report_pdf
string

S3 path to the NMVTIS vehicle history report PDF

​
nmvtis_last_fetch
string

Timestamp of last NMVTIS data fetch

​
state_txn_id
string

Transaction ID for state DMV data pull (Yassi, DMV123, or internal)

​
state_pull
string

S3 URL to JSON file containing the state DMV pull results as AccountData

​
state_found_status
string

Whether state DMV found records: 'found' or 'not_found'

​
state_report_pdf
string

S3 path to the state DMV report PDF

​
state_last_fetch
string

Timestamp of last state DMV data fetch

​
portal_screenshot
string

S3 path to a screenshot of the DMV portal showing current vehicle status

​
portal_pull
string

S3 URL to JSON file containing the DMV portal pull results as AccountData

​
portal_found_status
string

Whether DMV portal found the vehicle: 'found' or 'not_found'

​
portal_last_fetch
string

Timestamp of last DMV portal data fetch

​
insurance_last_fetch
string<date-time>

Timestamp of last insurance data fetch

​
insurance_search_raw_data
object

Raw insurance search data

​
insurance_search_result
string

Insurance search result status

​
insurance_update_result
string

Insurance update result status

​
signature_requests
object[]

Electronic signature requests including signed documents, certificates, and collected driver licenses

​
fee_estimate
object