Skip to main content
PATCH
/
title
/
{id}
Update a title entry
curl --request PATCH \
  --url https://dev.cardinalgray.com/title/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>",
      "registration_issuance_date": "<string>",
      "class": "<string>",
      "has_reg_title_holds": true,
      "reg_title_holds": [
        {
          "hold_type": "INSURANCE",
          "hold_code": "<string>",
          "hold_description": "<string>",
          "issue_date": "<string>",
          "clear_date": "<string>",
          "source": "<string>"
        }
      ],
      "prev_date_of_sale": "<string>",
      "prev_sale_price": "<string>",
      "fee_history": [
        {
          "feeType": "<string>",
          "name": "<string>",
          "value": 123
        }
      ],
      "insurance": {
        "provider_name": "<string>",
        "provider_naic": "<string>",
        "policy_number": "<string>"
      },
      "title": {
        "number": "<string>",
        "issuing_state": "<string>",
        "issuing_county": "<string>",
        "issuance_date": "2023-12-25",
        "brand": "SALVAGE",
        "brand_code": "<string>",
        "brands": [
          {
            "brand": "SALVAGE",
            "nmvtis_code": "<string>",
            "state_code": "<string>"
          }
        ],
        "odometer_reading": "<string>",
        "odometer_reading_unit": "MI",
        "odometer_code": "<string>",
        "odometer_code_translation": "ACTUAL",
        "has_liens": true,
        "active_liens": [
          {
            "lien_date": "<string>",
            "lienholder": {
              "type": "LIENHOLDER",
              "name": "<string>",
              "addr": {
                "street1": "<string>",
                "city": "<string>",
                "state": "<string>",
                "zip": "<string>",
                "recipient_name": "<string>",
                "street2": "<string>",
                "county": "<string>"
              },
              "id": "<string>",
              "name_first": "<string>",
              "name_middle": "<string>",
              "name_last": "<string>",
              "name_suffix": "<string>",
              "oats_names": [
                "<string>"
              ],
              "contact_phone": "<string>",
              "contact_email": "<string>",
              "elt_id": "<string>",
              "feid": "<string>"
            },
            "lien_amount": "<string>",
            "lien_id": "<string>"
          }
        ],
        "is_electronic": true,
        "is_and": true,
        "is_or": true,
        "is_tod": true,
        "is_jtwros": true,
        "conjunction": "AND",
        "is_leased": true,
        "previous_title": "<unknown>",
        "owner_names_one_line": "<string>",
        "number_of_owners": 123,
        "owners": [
          {
            "type": "PERSON",
            "name": "<string>",
            "addr": {
              "street1": "<string>",
              "city": "<string>",
              "state": "<string>",
              "zip": "<string>",
              "recipient_name": "<string>",
              "street2": "<string>",
              "county": "<string>"
            },
            "dob": "<string>",
            "id": "<string>",
            "name_first": "<string>",
            "name_middle": "<string>",
            "name_last": "<string>",
            "name_suffix": "<string>",
            "oats_names": [
              "<string>"
            ],
            "contact_phone": "<string>",
            "contact_email": "<string>",
            "ssn": "<string>",
            "insurance": {
              "provider_name": "<string>",
              "provider_naic": "<string>",
              "policy_number": "<string>"
            },
            "ownership_type": "<string>",
            "is_nonobligor": true
          }
        ],
        "status": "active",
        "status_raw_text": "<string>",
        "prev_action": "original",
        "prev_action_raw_text": "<string>"
      }
    },
    "salvage": {
      "type": "THEFT",
      "insurance": {
        "provider_name": "<string>",
        "provider_naic": "<string>",
        "policy_number": "<string>"
      },
      "claim_number": "<string>",
      "total_loss_date": "<string>",
      "payoff_date": "<string>"
    }
  }
}
'
{
  "website": "<string>",
  "entryId": "<string>",
  "userId": "<string>",
  "job_status": "pending",
  "createdAt": "<string>",
  "s3Index": "<string>",
  "VIN": "<string>",
  "state": "<string>",
  "Borrower": "<string>",
  "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>",
      "registration_issuance_date": "<string>",
      "class": "<string>",
      "has_reg_title_holds": true,
      "reg_title_holds": [
        {
          "hold_type": "INSURANCE",
          "hold_code": "<string>",
          "hold_description": "<string>",
          "issue_date": "<string>",
          "clear_date": "<string>",
          "source": "<string>"
        }
      ],
      "prev_date_of_sale": "<string>",
      "prev_sale_price": "<string>",
      "fee_history": [
        {
          "feeType": "<string>",
          "name": "<string>",
          "value": 123
        }
      ],
      "insurance": {
        "provider_name": "<string>",
        "provider_naic": "<string>",
        "policy_number": "<string>"
      },
      "title": {
        "number": "<string>",
        "issuing_state": "<string>",
        "issuing_county": "<string>",
        "issuance_date": "2023-12-25",
        "brand": "SALVAGE",
        "brand_code": "<string>",
        "brands": [
          {
            "brand": "SALVAGE",
            "nmvtis_code": "<string>",
            "state_code": "<string>"
          }
        ],
        "odometer_reading": "<string>",
        "odometer_reading_unit": "MI",
        "odometer_code": "<string>",
        "odometer_code_translation": "ACTUAL",
        "has_liens": true,
        "active_liens": [
          {
            "lien_date": "<string>",
            "lienholder": {
              "type": "LIENHOLDER",
              "name": "<string>",
              "addr": {
                "street1": "<string>",
                "city": "<string>",
                "state": "<string>",
                "zip": "<string>",
                "recipient_name": "<string>",
                "street2": "<string>",
                "county": "<string>"
              },
              "id": "<string>",
              "name_first": "<string>",
              "name_middle": "<string>",
              "name_last": "<string>",
              "name_suffix": "<string>",
              "oats_names": [
                "<string>"
              ],
              "contact_phone": "<string>",
              "contact_email": "<string>",
              "elt_id": "<string>",
              "feid": "<string>"
            },
            "lien_amount": "<string>",
            "lien_id": "<string>"
          }
        ],
        "is_electronic": true,
        "is_and": true,
        "is_or": true,
        "is_tod": true,
        "is_jtwros": true,
        "conjunction": "AND",
        "is_leased": true,
        "previous_title": "<unknown>",
        "owner_names_one_line": "<string>",
        "number_of_owners": 123,
        "owners": [
          {
            "type": "PERSON",
            "name": "<string>",
            "addr": {
              "street1": "<string>",
              "city": "<string>",
              "state": "<string>",
              "zip": "<string>",
              "recipient_name": "<string>",
              "street2": "<string>",
              "county": "<string>"
            },
            "dob": "<string>",
            "id": "<string>",
            "name_first": "<string>",
            "name_middle": "<string>",
            "name_last": "<string>",
            "name_suffix": "<string>",
            "oats_names": [
              "<string>"
            ],
            "contact_phone": "<string>",
            "contact_email": "<string>",
            "ssn": "<string>",
            "insurance": {
              "provider_name": "<string>",
              "provider_naic": "<string>",
              "policy_number": "<string>"
            },
            "ownership_type": "<string>",
            "is_nonobligor": true
          }
        ],
        "status": "active",
        "status_raw_text": "<string>",
        "prev_action": "original",
        "prev_action_raw_text": "<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",
  "lenderLoanId": "<string>",
  "tracking_url_provider": "<string>",
  "webhook_events": [
    "<string>"
  ],
  "user_email": "<string>",
  "groupId": "<string>",
  "last_modified": 123,
  "existingEntryId": "<string>",
  "bdaJobs": {},
  "attachment": [
    {
      "display_name": "<string>",
      "s3_key": "<string>",
      "document_type": "VEHICLE_TITLE",
      "json_path": "<string>"
    }
  ],
  "lmsData": {},
  "loanData": {
    "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>",
      "registration_issuance_date": "<string>",
      "class": "<string>",
      "has_reg_title_holds": true,
      "reg_title_holds": [
        {
          "hold_type": "INSURANCE",
          "hold_code": "<string>",
          "hold_description": "<string>",
          "issue_date": "<string>",
          "clear_date": "<string>",
          "source": "<string>"
        }
      ],
      "prev_date_of_sale": "<string>",
      "prev_sale_price": "<string>",
      "fee_history": [
        {
          "feeType": "<string>",
          "name": "<string>",
          "value": 123
        }
      ],
      "insurance": {
        "provider_name": "<string>",
        "provider_naic": "<string>",
        "policy_number": "<string>"
      },
      "title": {
        "number": "<string>",
        "issuing_state": "<string>",
        "issuing_county": "<string>",
        "issuance_date": "2023-12-25",
        "brand": "SALVAGE",
        "brand_code": "<string>",
        "brands": [
          {
            "brand": "SALVAGE",
            "nmvtis_code": "<string>",
            "state_code": "<string>"
          }
        ],
        "odometer_reading": "<string>",
        "odometer_reading_unit": "MI",
        "odometer_code": "<string>",
        "odometer_code_translation": "ACTUAL",
        "has_liens": true,
        "active_liens": [
          {
            "lien_date": "<string>",
            "lienholder": {
              "type": "LIENHOLDER",
              "name": "<string>",
              "addr": {
                "street1": "<string>",
                "city": "<string>",
                "state": "<string>",
                "zip": "<string>",
                "recipient_name": "<string>",
                "street2": "<string>",
                "county": "<string>"
              },
              "id": "<string>",
              "name_first": "<string>",
              "name_middle": "<string>",
              "name_last": "<string>",
              "name_suffix": "<string>",
              "oats_names": [
                "<string>"
              ],
              "contact_phone": "<string>",
              "contact_email": "<string>",
              "elt_id": "<string>",
              "feid": "<string>"
            },
            "lien_amount": "<string>",
            "lien_id": "<string>"
          }
        ],
        "is_electronic": true,
        "is_and": true,
        "is_or": true,
        "is_tod": true,
        "is_jtwros": true,
        "conjunction": "AND",
        "is_leased": true,
        "previous_title": "<unknown>",
        "owner_names_one_line": "<string>",
        "number_of_owners": 123,
        "owners": [
          {
            "type": "PERSON",
            "name": "<string>",
            "addr": {
              "street1": "<string>",
              "city": "<string>",
              "state": "<string>",
              "zip": "<string>",
              "recipient_name": "<string>",
              "street2": "<string>",
              "county": "<string>"
            },
            "dob": "<string>",
            "id": "<string>",
            "name_first": "<string>",
            "name_middle": "<string>",
            "name_last": "<string>",
            "name_suffix": "<string>",
            "oats_names": [
              "<string>"
            ],
            "contact_phone": "<string>",
            "contact_email": "<string>",
            "ssn": "<string>",
            "insurance": {
              "provider_name": "<string>",
              "provider_naic": "<string>",
              "policy_number": "<string>"
            },
            "ownership_type": "<string>",
            "is_nonobligor": true
          }
        ],
        "status": "active",
        "status_raw_text": "<string>",
        "prev_action": "original",
        "prev_action_raw_text": "<string>"
      }
    },
    "salvage": {
      "type": "THEFT",
      "insurance": {
        "provider_name": "<string>",
        "provider_naic": "<string>",
        "policy_number": "<string>"
      },
      "claim_number": "<string>",
      "total_loss_date": "<string>",
      "payoff_date": "<string>"
    }
  },
  "is_elt": true,
  "form_statement_of_fact": "<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_name": "<string>",
      "form_generic": "<string>",
      "signer_id": "<string>",
      "form": "<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_name": "<string>",
      "form_generic": "<string>",
      "signer_id": "<string>",
      "form": "<string>"
    }
  ],
  "forms_non_obligor": [
    {
      "signer_name": "<string>",
      "form_generic": "<string>",
      "signer_id": "<string>",
      "form": "<string>"
    }
  ],
  "form_updates": {},
  "form_downloads": {},
  "nmvtis_txn_id": "<string>",
  "nmvtis_pull": "<string>",
  "nmvtis_found_status": "<unknown>",
  "nmvtis_report_pdf": "<string>",
  "nmvtis_last_fetch": "<string>",
  "state_txn_id": "<string>",
  "state_pull": "<string>",
  "state_found_status": "found",
  "state_report_pdf": "<string>",
  "state_last_fetch": "<string>",
  "portal_screenshot": "<string>",
  "portal_pull": "<string>",
  "portal_found_status": "<unknown>",
  "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": [
    {
      "transaction_access_url": "<string>",
      "requester_email": "<string>",
      "id": "<string>",
      "type": "WET_SIGN",
      "status": "DRAFT",
      "documents_to_sign": [
        {
          "filename": "<string>",
          "id": "<string>",
          "signer_id": [
            "<string>"
          ],
          "signed_copy": "<string>"
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "signers": [
        {
          "type": "PERSON",
          "name": "<string>",
          "addr": {
            "street1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip": "<string>",
            "recipient_name": "<string>",
            "street2": "<string>",
            "county": "<string>"
          },
          "dob": "<string>",
          "id": "<string>",
          "name_first": "<string>",
          "name_middle": "<string>",
          "name_last": "<string>",
          "name_suffix": "<string>",
          "oats_names": [
            "<string>"
          ],
          "contact_phone": "<string>",
          "contact_email": "<string>",
          "ssn": "<string>",
          "insurance": {
            "provider_name": "<string>",
            "provider_naic": "<string>",
            "policy_number": "<string>"
          },
          "ownership_type": "<string>",
          "is_nonobligor": true
        }
      ],
      "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": {}
    }
  ],
  "account_discrepancies": {
    "items": [
      {
        "field_path": "<string>",
        "observations": [
          {
            "from": {
              "kind": "document_upload",
              "ref_id": "<string>",
              "doc_type": "<string>"
            },
            "value": "<unknown>"
          }
        ]
      }
    ]
  },
  "account_matches": {
    "items": [
      {
        "field_path": "<string>",
        "agreed_value": "<unknown>",
        "sources": [
          {
            "kind": "document_upload",
            "ref_id": "<string>",
            "doc_type": "<string>"
          }
        ]
      }
    ]
  }
}
The request body should contain only the fields you wish to update. The primary key fields website and entryId cannot be modified and will be automatically removed from the update operation if included.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique identifier of the title entry

Body

application/json

Account data updates to apply to the title entry

​
account_data
object
required

Partial or complete account data to merge with existing entry

Response

Title entry updated successfully

​
website
string
required

Organization identifier

​
entryId
string
required

Unique identifier for this database entry

​
userId
string
required

User who created this entry

​
job_status
enum<string>
required

Processing status of the job

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

Timestamp when this entry was created

​
s3Index
string
required

S3 path prefix for this entry's documents

​
VIN
string
required

Vehicle Identification Number (17 characters)

​
state
string
required

State where the vehicle is titled/registered

​
Borrower
string
required

Primary borrower name on the loan

​
account_data
object
required
​
account_status
enum<string>
required

Account status to determine workflows (scrapers, etc.)

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
​
lenderLoanId
string
required

Lender's internal loan/account number

​
tracking_url_provider
string
required

Service provider for shipping tracking (if applicable)

​
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

​
groupId
string

User group ID for organizational access control

​
last_modified
number

Timestamp when this entry was last modified

​
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
object

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

​
is_elt
boolean

Whether this account uses Electronic Lien & Title system

​
elt_data
object
​
form_statement_of_fact
string

S3 path to the Statement of Fact form PDF

​
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
any

NMVTIS pull status: 'found' (record exists), 'not_found' (no record), 'error' (CG failure, retry), 'unavailable' (source down)

​
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
enum<string>

State DMV pull status: 'found' (record exists), 'not_found' (no record), 'error' (CG failure, retry), 'unavailable' (source down)

Available options:
found,
not_found,
error,
unavailable
​
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
any

DMV portal pull status: 'found' (record exists), 'not_found' (no record), 'error' (CG failure, retry), 'unavailable' (portal down)

​
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
​
account_discrepancies
object

Discrepancies found between different data sources (document uploads, NMVTIS, state portals, etc.) for this account. Each discrepancy shows field path and conflicting values with their sources.

​
account_matches
object

Fields where multiple data sources agree on the same value, providing validation confidence for critical data points like title numbers, dates, etc.