curl --request GET \
--url https://api.example.com/v1/patient-policies \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/v1/patient-policies"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/v1/patient-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/patient-policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/patient-policies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/patient-policies")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/patient-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"insurance_id": "<string>",
"member_number": "<string>",
"coverage_tier": "primary",
"insurance_display_name": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"medicaid_id": "<string>",
"plan_name": "<string>",
"insurance_type": "01",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"relationship_to_subscriber": "spouse",
"subscriber": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"gender": "male",
"member_number": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "alabama",
"zip": "<string>"
},
"external_id": "<string>",
"active": true,
"version": 0,
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"patient_policy_id": "<string>",
"billing_credentialing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_network_status": "unknown",
"cbh_status": "active",
"plan_funding_type": "fully_funded",
"plan_renewal_date_type": "calendar_year",
"benefit_period_end_date": "2023-12-25",
"cob_on_file": true,
"cob_last_verified_at": "2023-11-07T05:31:56Z",
"has_other_active_coverage": true,
"cob_other_coverages": [
{
"name": "<string>",
"position": "primary"
}
],
"out_of_state_benefits": true,
"out_of_state_benefits_comments": "<string>",
"in_grace_period": true,
"last_payment_date": "2023-12-25",
"is_cobra_coverage": true,
"deductible_apply_to_oop": true,
"eligibility_check_status": "pending",
"eligibility_check_comment": "<string>",
"eligibility_check_date": "2023-11-07T05:31:56Z",
"eligibility_version": 0,
"individual_deductible_policy_in_network": 123,
"individual_deductible_policy_out_network": 123,
"individual_deductible_remaining_in_network": 123,
"individual_deductible_remaining_out_network": 123,
"family_deductible_policy_in_network": 123,
"family_deductible_policy_out_network": 123,
"family_deductible_remaining_in_network": 123,
"family_deductible_remaining_out_network": 123,
"individual_oop_max_policy_in_network": 123,
"individual_oop_max_policy_out_network": 123,
"individual_oop_max_remaining_in_network": 123,
"individual_oop_max_remaining_out_network": 123,
"family_oop_max_policy_in_network": 123,
"family_oop_max_policy_out_network": 123,
"family_oop_max_remaining_in_network": 123,
"family_oop_max_remaining_out_network": 123,
"benefits_related_entities": [
{}
],
"ai_summary": "<string>",
"ai_summary_generated_at": "2023-11-07T05:31:56Z",
"patient": {},
"services": [
{
"copay_in_network": 25,
"created_at": "2024-01-15T10:30:00Z",
"eligibility_check_status": "ELIGIBLE",
"id": "550e8400-e29b-41d4-a716-446655440014",
"payor_id": "550e8400-e29b-41d4-a716-446655440012",
"service_type": "PT",
"updated_at": "2024-01-15T10:30:00Z",
"verification_benefits_status": "VERIFIED"
}
],
"active": true,
"version": 1
},
"insurance": {},
"patient": {}
}
],
"pagination": {
"has_more": true,
"total": 123,
"page": 123,
"limit": 123
}
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}List Patient Policies
List the company’s patient policies. Only active policies are ever listed; a deleted policy never appears here.
curl --request GET \
--url https://api.example.com/v1/patient-policies \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/v1/patient-policies"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/v1/patient-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/patient-policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/patient-policies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/patient-policies")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/patient-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"insurance_id": "<string>",
"member_number": "<string>",
"coverage_tier": "primary",
"insurance_display_name": "<string>",
"group_number": "<string>",
"group_description": "<string>",
"medicaid_id": "<string>",
"plan_name": "<string>",
"insurance_type": "01",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"relationship_to_subscriber": "spouse",
"subscriber": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"gender": "male",
"member_number": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "alabama",
"zip": "<string>"
},
"external_id": "<string>",
"active": true,
"version": 0,
"current_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"patient_policy_id": "<string>",
"billing_credentialing_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_network_status": "unknown",
"cbh_status": "active",
"plan_funding_type": "fully_funded",
"plan_renewal_date_type": "calendar_year",
"benefit_period_end_date": "2023-12-25",
"cob_on_file": true,
"cob_last_verified_at": "2023-11-07T05:31:56Z",
"has_other_active_coverage": true,
"cob_other_coverages": [
{
"name": "<string>",
"position": "primary"
}
],
"out_of_state_benefits": true,
"out_of_state_benefits_comments": "<string>",
"in_grace_period": true,
"last_payment_date": "2023-12-25",
"is_cobra_coverage": true,
"deductible_apply_to_oop": true,
"eligibility_check_status": "pending",
"eligibility_check_comment": "<string>",
"eligibility_check_date": "2023-11-07T05:31:56Z",
"eligibility_version": 0,
"individual_deductible_policy_in_network": 123,
"individual_deductible_policy_out_network": 123,
"individual_deductible_remaining_in_network": 123,
"individual_deductible_remaining_out_network": 123,
"family_deductible_policy_in_network": 123,
"family_deductible_policy_out_network": 123,
"family_deductible_remaining_in_network": 123,
"family_deductible_remaining_out_network": 123,
"individual_oop_max_policy_in_network": 123,
"individual_oop_max_policy_out_network": 123,
"individual_oop_max_remaining_in_network": 123,
"individual_oop_max_remaining_out_network": 123,
"family_oop_max_policy_in_network": 123,
"family_oop_max_policy_out_network": 123,
"family_oop_max_remaining_in_network": 123,
"family_oop_max_remaining_out_network": 123,
"benefits_related_entities": [
{}
],
"ai_summary": "<string>",
"ai_summary_generated_at": "2023-11-07T05:31:56Z",
"patient": {},
"services": [
{
"copay_in_network": 25,
"created_at": "2024-01-15T10:30:00Z",
"eligibility_check_status": "ELIGIBLE",
"id": "550e8400-e29b-41d4-a716-446655440014",
"payor_id": "550e8400-e29b-41d4-a716-446655440012",
"service_type": "PT",
"updated_at": "2024-01-15T10:30:00Z",
"verification_benefits_status": "VERIFIED"
}
],
"active": true,
"version": 1
},
"insurance": {},
"patient": {}
}
],
"pagination": {
"has_more": true,
"total": 123,
"page": 123,
"limit": 123
}
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Authorizations
Query Parameters
Filter by patient ID
Filter by insurance ID
Filter by coverage tier Insurance tier enum matching Prisma
primary, secondary, tertiary, quaternary Filter by external ID
Search: member number contains this text (case-insensitive)
Expiration bucket, ANDed with the other filters. 'expiring' = end_date from today through the next 30 days; 'expired' = end_date before today; 'eligibility_stale' = the current verification's eligibility_check_date is set and older than 90 days (its deductible/OOP remaining values are likely outdated).
The insurance expirations dashboard's buckets. The windows are the
backend's (app.shared.constants.expirations); the frontend only names
them.
all, expiring, expired, eligibility_stale Coverage starts on or after this date
Coverage starts on or before this date
Coverage ends on or after this date
Coverage ends on or before this date
The current verification's eligibility check status (active, inactive, pending) Eligibility check status. Bound to the PG enum "EligibilityStatus" (labels pending, active, inactive, failed) used by eligibility_checks.eligibility_status. payors.eligibility_check_status is a different PG type (eligibility_check_status, no failed) and is declared literally on the Payor model.
active, inactive, pending, failed The current verification's provider network status Provider network status enum matching Prisma @map values
unknown, in_network, out_of_network Page number (1-based)
x >= 1Number of items per page
1 <= x <= 100Expand related resources ('insurance', 'patient')
Response
Successful Response
List response for patient policies.
Show child attributes
Show child attributes
Pagination information for list responses.
Fields:
- has_more: Whether more items exist beyond this page
- total: Total number of items across all pages
- page: Current page number (1-based)
- limit: Number of items per page
Show child attributes
Show child attributes

