Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nirvana Health Coverage Scan API

Multi-payer coverage discovery.

Nirvana Health Coverage Scan API is one of 4 APIs that Nirvana Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Coverage Scan. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version v1.

Requests are made against a single base URL, https://coverage-api.meetnirvana.com.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1
Base URL
https://coverage-api.meetnirvana.com/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Nirvana Health Coverage Scan API declares 1 security scheme for authenticating requests. An API key is passed in the header as apikey (apiKeyHeader). By default, every request must be authenticated.

  • apiKeyHeader — Nirvana issues an API key on request. Pass it in the apikey request header on every call. Contact Nirvana to provision a key.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Coverage Scan 1

Multi-payer coverage discovery.

POST
/v1/scan
Scan payers for active coverage
scan_v1_scan_post body → 200400401422429500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CoverageRequest (15 properties), Benefits (9 properties), CoverageResult (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
Benefits
object
Payer-normalized, specialty-specific benefit details.
9 properties
CoverageRequest
object
15 properties 4 required
CoverageResult
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nirvana-coverage-scan-api-openapi.yml Raw ↑

Other APIs Nirvana Health publishes across the network.

Nirvana Health Cost Estimation API
Nirvana Health Eligibility API
Nirvana Health Medicaid API