curl --request GET \
--url https://api.openloophealth.com/v0.1/payers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.openloophealth.com/v0.1/payers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.openloophealth.com/v0.1/payers', 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.openloophealth.com/v0.1/payers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.openloophealth.com/v0.1/payers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.openloophealth.com/v0.1/payers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openloophealth.com/v0.1/payers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"payers": [
{
"payer_id": "06603",
"name": "ASA GEHA",
"names": [
"Aetna Signature Administrators GEHA"
],
"states": [
"NATIONAL"
],
"eligibility_support": "SUPPORTED",
"programs": [
"COMMERCIAL"
]
},
{
"payer_id": "HLPAE",
"name": "Hill Physicians Aetna Preferred Provider Organization",
"names": [],
"states": [
"CA"
],
"eligibility_support": "SUPPORTED",
"programs": [
"COMMERCIAL"
]
}
],
"next_cursor": "eyJ2IjoiMjAyNi0wOS0zMFQwNjowMDowMFoiLCJvIjoyfQ"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "Unknown program. Allowed values: COMMERCIAL, MEDICARE, MEDICAID, MEDICARE_ADVANTAGE, TRICARE, VETERANS_AFFAIRS, WORKERS_COMPENSATION, AUTOMOBILE_MEDICAL.",
"error_code": "BAD_REQUEST"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "the token carries no organization",
"error_code": "AUTHENTICATION_ERROR"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "insufficient_permissions",
"error_code": "FORBIDDEN"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "Too many requests. Retry later.",
"error_code": "TOO_MANY_REQUESTS"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "Internal server error",
"error_code": "UNHANDLED_EXCEPTION"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "The Payer Directory is not ready. Try again later.",
"error_code": "NETWORK_ERROR"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}List or search payers
Lists the payers whose payer_id an eligibility verification and a coordination check accept. Send an entry’s payer_id unchanged, character for character.
The directory is OpenLoop’s copy of the payer network’s list, refreshed daily. A request reads that copy and never contacts a payer, so an entry can be up to a day old.
Without parameters the response carries every payer in one response, ordered by name, then payer_id, with next_cursor: null.
search matches names only: the name and the other names, never an id. The best match ranks first: an exact name, then a name prefix, then an exact other name, then a substring of any name. Inside each of these, national payers come first, then name, then payer_id. Only when none of these match does a typo-tolerant match run, ordered by how close the name is.
state keeps payers that operate in that state, and national payers. state=NATIONAL keeps only national payers. A payer with no state data never passes a state filter.
programs keeps payers that have any of the listed programs. A payer whose programs is empty never passes a program filter, though the unfiltered list has it.
All given parameters combine: search, then state, then programs. No match is a 200 with an empty payers, not a 404.
Paging is off unless you send limit. With limit, each page returns next_cursor, or null on the last page. Send the same search, state, programs and limit with the cursor: it does not remember them, so changing one between pages returns the wrong page rather than an error. A cursor stops working when the directory refreshes; the 400 tells you to restart.
A listed payer says nothing about network status, contracting or billability. The directory is also not a list of the payer ids POST /network-status accepts.
The organization comes from your access token’s organization claim; there is no query parameter for it. A token carrying no claim is a 401.
Responses of 1 KB or more are gzip-compressed when you send Accept-Encoding: gzip.
Not yet enabled on the production edge. This path appears in the reference but answers 404 against the production server, and there is no committed enablement date. Do not sequence a launch behind it. Confirm status with your OLH implementation contact before designing against it.
Permissions: eligibility:read. eligibility:write is not accepted in its place.
curl --request GET \
--url https://api.openloophealth.com/v0.1/payers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.openloophealth.com/v0.1/payers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.openloophealth.com/v0.1/payers', 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.openloophealth.com/v0.1/payers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.openloophealth.com/v0.1/payers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.openloophealth.com/v0.1/payers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openloophealth.com/v0.1/payers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"payers": [
{
"payer_id": "06603",
"name": "ASA GEHA",
"names": [
"Aetna Signature Administrators GEHA"
],
"states": [
"NATIONAL"
],
"eligibility_support": "SUPPORTED",
"programs": [
"COMMERCIAL"
]
},
{
"payer_id": "HLPAE",
"name": "Hill Physicians Aetna Preferred Provider Organization",
"names": [],
"states": [
"CA"
],
"eligibility_support": "SUPPORTED",
"programs": [
"COMMERCIAL"
]
}
],
"next_cursor": "eyJ2IjoiMjAyNi0wOS0zMFQwNjowMDowMFoiLCJvIjoyfQ"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "Unknown program. Allowed values: COMMERCIAL, MEDICARE, MEDICAID, MEDICARE_ADVANTAGE, TRICARE, VETERANS_AFFAIRS, WORKERS_COMPENSATION, AUTOMOBILE_MEDICAL.",
"error_code": "BAD_REQUEST"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "the token carries no organization",
"error_code": "AUTHENTICATION_ERROR"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "insufficient_permissions",
"error_code": "FORBIDDEN"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "Too many requests. Retry later.",
"error_code": "TOO_MANY_REQUESTS"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "Internal server error",
"error_code": "UNHANDLED_EXCEPTION"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}{
"error": {
"message": "The Payer Directory is not ready. Try again later.",
"error_code": "NETWORK_ERROR"
},
"request_id": "c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"
}Authorizations
Query Parameters
Comma-separated programs, in any letter case. Keeps payers that have any of them. An unknown program is a 400.
A program as the payer network reports it. The list is not published, and this enum grows when a new value appears.
COMMERCIAL, MEDICARE, MEDICAID, MEDICARE_ADVANTAGE, TRICARE, VETERANS_AFFAIRS, WORKERS_COMPENSATION, AUTOMOBILE_MEDICAL 
