PrimaryCheck API documentation
Base URL https://api.primarycheck.com/v1. JSON, camelCase, ISO-8601 timestamps in UTC, ISO-3166-2 state codes. Async by default with signed webhooks. One error shape.
Reference sections
Quickstart
Create a sandbox key, run your first verification, and read the verdict.
Authentication
Bearer API keys, live and test modes, and FCRA access.
Verifications
Create, read, list and cancel verifications; long-poll with ?wait.
Claim types
Every claim type: license, npi, exclusion_screen, healthcare_screen, certification, education, employment, monitors.
Verdicts and reasons
How verified, discrepancy, not_found, unable_to_verify and pending are decided.
Evidence
Evidence ids, signed download URLs, SHA-256 hashes and retention for every source result.
Webhooks
Events, signatures, retries and replay.
Idempotency
Safe retries with Idempotency-Key.
Versioning
Path version plus a date-pinned behavior header.
Errors
One error shape, with type, code, message, param and requestId.
Sandbox
Deterministic outcomes with magic names; every live source code present.
Coverage endpoint
Ask what we can verify before you ask us to verify it.
Healthcare screen
License + NPI + every exclusion list in one claim, priced as one.
Education checks
National Student Clearinghouse first, registrar outreach second, accreditation always.
Employment checks
Payroll connect, optional The Work Number, then our employer outreach engine.
Certifications
Issuer lookups by credential ID: AHA, NREMT, CompTIA, PMI, cloud vendors and more.
Monitoring
Re-check a license or person on a cadence and get a webhook on any change.
Hosted consent
Standalone disclosure + authorization on our page, with state add-ons, returning a consentId.
FCRA program
What PrimaryCheck does as a consumer reporting agency, and what you must do as a user of reports.
Adverse action API
Pre-adverse notice, the waiting period, and the final notice — run for you.
Disputes API
Consumer disputes, the 30/45-day clock, and corrected reports.
Consumer portal
How consumers request their file, read it and dispute it.
Notices
Summary of Rights, Notice to Users, Notice to Furnishers, and our consent texts.
Report PDF
The consumer report file: cover, verdicts, every source record, evidence hashes, notices.
Rate limits
Per-key limits, headers, and how we protect the sources.
Changelog
API versions and additive changes.
API reference
Every endpoint, parameter, request and response schema, generated from the OpenAPI document.
SDKs
Official Python and Node.js clients: create and wait, webhooks, errors, retries, idempotency.
Result reuse (maxAge)
Accept a result we already produced for the same claim within a window, and know when you did.
Cancelling
Stop pending claims; final claims keep their verdicts.
Usage and billing
The usage endpoint, list prices per claim type, and the dashboard-versus-API split.
Accounts and team
Sign-up, magic-link sessions, roles, API keys and invites.