Quickstart

Create an account

Register, verify your email, then log in with the code we email you.

Create a key

Open API keys and choose Create key. Copy it now: it's shown once.

Call the API

Call GET /api/vendor/v1/me with your key in the X-API-Key header.

curl https://api-demo-safety.spotter.ai/api/vendor/v1/me \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch("https://api-demo-safety.spotter.ai/api/vendor/v1/me", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const me = await res.json();

import requests

res = requests.get(
    "https://api-demo-safety.spotter.ai/api/vendor/v1/me",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
me = res.json()

{
  "vendor_id": "8b0c6f1e-3d2a-4c7b-9e51-2f6a0d4c7b13",
  "environment": "sandbox",
  "enabled_services": ["mvr", "psp", "cdlis", "driver_reviews"]
}

Place an order

POST /api/vendor/v1/orders with the driver, a CDL image and the service flags, then read the result with GET /api/vendor/v1/orders/{id}. See Orders and Results and files.