Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
patient
object
required
insurance
object
required
provider
object
required
webhook_url
string<uri>

Optional webhook URL where eligibility check results will be sent. If provided, you'll receive a POST request with the eligibility check data when the check completes.

Example:

"https://your-domain.com/webhooks-url"

webhook_secret
string

Optional secret token for webhook authentication. If provided, webhook payloads will be sent with an 'Authorization: Bearer {secret}' header. Do not include the 'Bearer' prefix when providing the secret.

Example:

"your_webhook_secret_here"

Response

Eligibility check submitted successfully. The check is being processed asynchronously. You will receive a webhook notification when the check completes. You can also poll the GET endpoint to check status.

id
integer
required

Unique identifier for this eligibility check request

status
enum<string>
required

Current status of the eligibility check

Available options:
in-progress
created_at
string<date-time>

Timestamp when the request was created

customer_patient_id
string | null

The customer-provided patient identifier, if provided will be returned in every other response for this eligibility check.

Example:

"1234567890"