v1

latestOpenAPI 3.1.02026-08-04204105.4 KB

Recalls

Submit a bulk recalls batch

Submit up to 10,000 VINs for asynchronous recall processing. Provide VINs as a JSON array (vins), inline CSV text (csv), or an HTTPS link to a CSV file (csvUrl). Optionally provide a webhookUrl that CarsXE will POST to when the batch finishes. Poll the status endpoint or wait for the webhook, then fetch results.

x402 submissions must use the JSON vins array. The csv and csvUrl forms require CarsXE API-key authentication.

post/v1/recalls-batch/submit

Request body

vinsstring[]

Array of 17-character VINs (max 10,000 per batch).

csvstring

Inline CSV text containing VINs. Available with CarsXE API-key authentication only; x402 does not accept this form.

csvUrlstring

HTTPS link to a CSV file of VINs (max 5 MB) hosted on a supported storage provider (e.g. S3, GCS, Firebase, Dropbox). Available with CarsXE API-key authentication only; x402 does not accept this form.

webhookUrlstring

HTTPS URL for a customer webhook. CarsXE POSTs a JSON payload when the batch finishes. Must be a valid HTTPS URL allowed by CarsXE validation rules.

Response

Batch accepted and queued for processing.

successboolean

messagestring