Risk Intelligence
Submit Batch Job
POST
/v1/risk/batch$1.125 per scored entity (25% off)Submit 2–100 entities for async risk scoring. Returns a job ID immediately. With WEBHOOK or CALLBACK_URL delivery, results are POSTed as a signed risk.batch.complete event (see Webhooks). Jobs are visible only to the client that submitted them. A production job needs prepaid credit for every entity up front, and is billed per successfully scored entity when it finishes. Jobs are stored: they survive restarts, and an interrupted job closes as PARTIAL or FAILED with a note.
Send an Idempotency-Key header to retry safely.
Request body
| Field | Type | Description |
|---|---|---|
| entityTyperequired | string | one of "BUSINESS", "INDIVIDUAL" |
| entitiesrequired | array of object | Array of entity objects matching BusinessRiskRequest or IndividualRiskRequest schema min 2 items · max 100 items |
| deliveryMethodoptional | string | one of "POLLING", "WEBHOOK", "CALLBACK_URL" · default "POLLING" |
| webhookUrloptional | string | URL to POST results when deliveryMethod is WEBHOOK format uri |
| webhookSecretoptional | string | Secret for webhook signature validation max length 500 |
| callbackUrloptional | string | format uri |
Response fields
| Field | Type | Description |
|---|---|---|
| success | boolean | |
| data | object | |
| data.jobId | string | |
| data.status | string | |
| data.totalItems | integer | |
| data.estimatedCompletionSeconds | integer |
Errors
- 400 invalid request
- 401 missing or bad key
- 403 not in your plan
- 429 rate limited, see Retry-After
- 402 payment required
- 5xx retry with backoff
Error bodies and codes are described in Error codes and troubleshooting.