Quickstart
Get your first simulated eligibility result.
Use a sandbox credential to prove your integration before any real payer is contacted. The first response is deterministic, safe, and designed for automated tests.
Step 1 — Exchange your client credential
Client credentials are environment-bound. The resulting access token is short-lived and used only by your server.
Step 2 — Queue a deterministic sandbox verification
Every verification requires an Idempotency-Key. Reusing it for the same logical request safely returns the original job.
Step 3 — Read the normalized result
Use the verification ID from the accepted response. Store it alongside your own reference so operations can trace a single request without exposing raw payer responses.
Reference
Build against these three endpoints first. Credentials select the environment; callers never put an environment selector in the request body.
POST /api/oauth/token— exchange one environment-bound client credential for a short-lived access token.POST /api/v1/verifications— queue one verification. Returns202 Acceptedand the verification ID.GET /api/v1/verifications/{verificationId}— retrieve the current normalized status and result.
Sandbox scenarios
Set test.scenario only in sandbox. Scenarios are deterministic so your CI suite has stable expected outcomes.
verified— Eligible result. A successful simulated eligibility response.inactive— Ineligible result. A completed response with inactive coverage.incomplete— Unknown result. A normalized result that requires more data.manual_review— Unknown result. A fixture for your manual-review branch.payer_timeout— Retryable failure. A deterministic failed job to exercise safe retry handling.
Live testing is a controlled readiness gate
It performs real eligibility checks. It is deliberately not a switch on a sandbox request or a self-service shortcut to production. Live-test access requires an active BAA, per-application approval, an active developer workspace, a verification-ready practice, and a matching provider NPI.
Errors & support
Keep the environment, verification ID, request ID, UTC timestamp, and error code. Do not send authorization headers or patient details to support.
| 400 | The request is invalid Check field names, dates, and the sandbox scenario. Never include patient details in a support ticket. |
| 401 | The access token is invalid or expired Exchange the server-held client credential for a fresh short-lived token. |
| 403 | The environment or workspace is not authorized Confirm the application approval, selected workspace, and provider NPI for the intended environment. |
| 409 | The idempotency key conflicts Reuse a key only for the same logical verification. Generate a new key for a new request. |
| 429 | The request rate is limited Wait for the Retry-After value, then retry the same logical request safely. |
| 503 | The request could not be completed Retry with the same Idempotency-Key and retain the request ID for support. |
About webhooks. Webhooks are not part of the initial v1 contract. Poll the verification URL until a signed delivery surface and replay ledger are available.