Collateral Score

Collateral Score Batch (submit)

Changed on

Existing customers on legacy plans: Score up to 500 vehicles asynchronously, e.g. to re-score a loan book. Returns 202 with a batch_id; poll GET with it, or pass webhook_url to receive collateral_score.batch.completed. The example VIN 3TMKB5FNXRM012539 is free and never counted. Usage is checked up front for every other vehicle, so a 429 means the remaining quota is smaller than that count. Plans that allow overage are billed one Collateral Score call per vehicle that scores, when the batch completes. Hard-capped and prepaid plans are charged for every vehicle except the example VIN at submit, before the 202. One batch runs per account at a time.

post/v1/vehicle/collateral-score/batch

Request

  • Base URL
    https://api.carsxe.com
  • Auth
    API key in query parameter key

Request body

webhook_urlstring uri

Public HTTPS URL. Redirects are not followed.

Response

Batch accepted and processing.

successboolean
batch_idstring
status'processing' | 'completed'
totalinteger

Changes