Collateral Score Batch (submit)
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.
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.
Authorization
ApiKeyQuery Your CarsXE API key, passed as the key query parameter.
In: query
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Callbacks
batchCompleted
{
"success": true,
"batch_id": "8k2Yw1QeR4tTnVb7XcZa",
"status": "processing",
"total": 500
}{
"success": false,
"message": "vehicles[3]: zip is required and must be a 5-digit US ZIP code"
}{
"success": false,
"message": "Missing API key"
}{
"success": false,
"message": "The collateral-score API is not enabled for this account."
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "API usage limit exceeded",
"usage": {
"current": 1000,
"limit": 1000,
"remaining": 0
}
}{
"success": false,
"message": "Internal server error"
}{
"success": false,
"message": "The collateral-score API is temporarily unavailable. Please try again later."
}