Skip to content

Insurance Verifications

The InsuranceVerifications resource represents insurance verification records. Insurance verifications are read-only.

Endpoints

Method Path Description
GET /InsuranceVerifications List insurance verifications
GET /InsuranceVerifications({id}) Get a single insurance verification

List Insurance Verifications

GET /InsuranceVerifications

Supports: $filter, $select, $orderby, $top, $skip, $count, $expand

Example

curl -X GET "https://api.nymbldev.com/InsuranceVerifications?\$filter=verified eq true&\$orderby=verified_on desc" \
  -H "Authorization: Bearer eyJraWQiOiJ..." \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "@odata.context": "https://api.nymbldev.com/$metadata#InsuranceVerifications",
  "@odata.count": 88,
  "value": [
    {
      "id": 201,
      "prescription_id": 500,
      "verified": true,
      "verified_on": "2024-03-10",
      "effective_date": "2024-01-01",
      "expiration_date": "2024-12-31",
      "network_type": "IN",
      "pre_auth_necessary": false
    }
  ]
}

Get a Single Insurance Verification

GET /InsuranceVerifications({id})

Example

curl -X GET "https://api.nymbldev.com/InsuranceVerifications(201)" \
  -H "Authorization: Bearer eyJraWQiOiJ..." \
  -H "x-api-key: YOUR_API_KEY"
Property Type Description
Prescription Prescription The prescription this verification is associated with

Properties

Property Type Description
id number Unique identifier (required)
prescription_id number Associated prescription ID
patient_insurance_id number Patient insurance record ID
verified boolean Whether verification is complete
verified_on date Date verification was completed
verified_by_id number ID of the user who verified
effective_date date Coverage effective date
expiration_date date Coverage expiration date
termination_date date Coverage termination date
current_coverage boolean Whether coverage is current
carrier_type string Carrier type
network_type string Network type (e.g., IN, OUT)
benefits_payable string Benefits payable indicator
deductible_amount decimal Deductible amount
amount_met decimal Deductible amount met
out_of_pocket_amount decimal Out-of-pocket maximum
out_of_pocket_remaining decimal Out-of-pocket remaining
annual_max string Annual benefit maximum
life_time_max string Lifetime benefit maximum
pre_auth_necessary boolean Whether prior authorization is required
pre_auth_notes string Prior authorization notes
pre_auth_phone string Prior authorization phone number
referral_needed boolean Whether a referral is needed
referral_number string Referral number
authorization_date date Authorization date
notes string General notes
source_id number Source system record ID
source_name string Source system name

Common Query Examples

Verified records for a prescription: 

GET /InsuranceVerifications?$filter=prescription_id eq 500 and verified eq true

Active coverage: 

GET /InsuranceVerifications?$filter=current_coverage eq true and expiration_date ge 2024-01-01

Records requiring prior authorization: 

GET /InsuranceVerifications?$filter=pre_auth_necessary eq true&$select=id,prescription_id,pre_auth_notes,pre_auth_phone