SNH AI Background Check API
Programmatic API for employment, education, and related verification workflows. Orders run asynchronously; your integration should create orders, poll search state (or rely on webhooks), and handle errors with retries where appropriate. The API is multi-tenant: your JWT must include the tenant claim SNH AI configures for your account.Why SNH AI
- Automated contact discovery — AI research finds HR and registrar-facing contacts via web signals, geography, organization research, and scoring (no spreadsheets of phone numbers required).
- Multi-channel orchestration — Policies drive email → fax → voice fallbacks in production.
- Structured outcomes — Inbound payloads route through extraction so verification.completed closes with structured verification data.
- Async-first integration — Create orders immediately; track progress via webhooks and search polling (Webhook overview).
How to integrate
- Authentication — Bearer JWT on every call except
GET /health; request sandbox credentials from SNH AI . - Quickstart — Health check, optional release-form upload, create one employment order, fetch order and searches, webhook outline.
- Order lifecycle — Create an order, inspect searches, and handle webhooks.
- Sandbox reference — Sandbox-specific limits before production.
- Background Check overview — Stable vs placeholder endpoints, base URLs, OpenAPI note.
- Orders — Create, Get, List searches, Get search.
- Webhooks — Overview, Events, Integration (signatures, routing, idempotency).
- Third-party ban — Configure searches so specific third-party vendors are not used.
- Error handling — Status codes and validation payloads.
Enterprise & production readiness
- Multi-tenant isolation — Every request is scoped to the
tenantclaim in your JWT; tokens never cross tenants. See Authentication. - Asynchronous by design — Order creation returns immediately; searches complete later. Drive state from webhooks and verify the
X-Webhook-Signature(HMAC-SHA256) before processing; use polling only as a fallback. - Resilient integration — Retry transient
5xx/network errors with backoff, never4xx, and treat order creation as non-idempotent — reconcile byexternalSearchIdrather than blindly resending. See Error handling. - SLAs & escalation — Searches that can’t auto-complete are escalated and reassigned on tenant-configurable SLAs. See SLA and automatic reassignment.
- Batches are placeholder today —
POST /batchescreates orders but has no durable batch tracking; record each returnedverificationOrderId. See Background Check overview.
Common client scenarios
See Integration patterns for short examples: employment-only, education-only, combined checks, skip-research with contact hints, third-party vendor bans, email-only channel policy, manual review, per-search webhook routing, release-form upload, batch create caveats, and webhook idempotency.Support
Support
Contact our support team
Status
System status