POST /api/vendor/v1/orders orders background checks for one driver. Send multipart/form-data (at most 32 MB in all) with an Idempotency-Key header.
curl -X POST https://api-demo-safety.spotter.ai/api/vendor/v1/orders \
-H "X-API-Key: YOUR_API_KEY" \
-H "Idempotency-Key: 9d4e1f0a-2b6c-4c8e-a1f3-7e5d2c9b8a60" \
-F first_name=Jane \
-F last_name=Doe \
-F date_of_birth=1985-04-12 \
-F license_number=D1234567 \
-F license_state=FL \
-F mc_number=MC-123456 \
-F mvr_requested=true \
-F psp_requested=true \
-F cdlis_requested=true \
-F driver_reviews_requested=true \
-F ssn=DRIVER_SSN \
-F cdl_image=@cdl-front.jpgFields
Required: first_name, last_name, date_of_birth (YYYY-MM-DD), license_number, license_state, mc_number and cdl_image.
Optional: middle_name, name_suffix, class_type, issue_date, expiry_date and back_of_cdl.
Set at least one of mvr_requested, psp_requested, cdlis_requested and driver_reviews_requested to true. Omitted flags mean false. Send ssn only with CDLIS; it is required then.
Images must be image/jpeg, image/png, image/webp, image/heic, application/pdf, at most 15 MB each.
Response
The response is the order, with a Location header: 202 and Retry-After while processing, or 200 when completed. Wait for Retry-After before reading the order again.
Idempotency
Choose a unique Idempotency-Key for each order. Retrying the same key and body returns the existing order. Reusing the key with a different body returns 409 idempotency_conflict.
Refusals
A refused request creates no order and incurs no charge. Check field errors for missing or invalid inputs. MVR must be available for the license state, and each requested service must be enabled on your account.
You can place 10 orders a minute per account, replays included.