Skip to main content
POST
/
api
/
v2
/
clearinghouse
/
check-eligibility
Check payer eligibility
curl --request POST \
  --url https://api.example.com/api/v2/clearinghouse/check-eligibility \
  --header 'Content-Type: application/json' \
  --data '
{
  "tradingPartnerServiceId": "<string>",
  "providerName": "<string>",
  "providerIdentifier": "<string>",
  "subscriberDateOfBirth": "<string>",
  "subscriberFirstName": "<string>",
  "subscriberLastName": "<string>",
  "subscriberMemberId": "<string>",
  "serviceTypeCodes": [
    "<string>"
  ],
  "encounterDateOfService": "<string>"
}
'
import requests

url = "https://api.example.com/api/v2/clearinghouse/check-eligibility"

payload = {
"tradingPartnerServiceId": "<string>",
"providerName": "<string>",
"providerIdentifier": "<string>",
"subscriberDateOfBirth": "<string>",
"subscriberFirstName": "<string>",
"subscriberLastName": "<string>",
"subscriberMemberId": "<string>",
"serviceTypeCodes": ["<string>"],
"encounterDateOfService": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
tradingPartnerServiceId: '<string>',
providerName: '<string>',
providerIdentifier: '<string>',
subscriberDateOfBirth: '<string>',
subscriberFirstName: '<string>',
subscriberLastName: '<string>',
subscriberMemberId: '<string>',
serviceTypeCodes: ['<string>'],
encounterDateOfService: '<string>'
})
};

fetch('https://api.example.com/api/v2/clearinghouse/check-eligibility', 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/api/v2/clearinghouse/check-eligibility",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tradingPartnerServiceId' => '<string>',
'providerName' => '<string>',
'providerIdentifier' => '<string>',
'subscriberDateOfBirth' => '<string>',
'subscriberFirstName' => '<string>',
'subscriberLastName' => '<string>',
'subscriberMemberId' => '<string>',
'serviceTypeCodes' => [
'<string>'
],
'encounterDateOfService' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v2/clearinghouse/check-eligibility"

payload := strings.NewReader("{\n \"tradingPartnerServiceId\": \"<string>\",\n \"providerName\": \"<string>\",\n \"providerIdentifier\": \"<string>\",\n \"subscriberDateOfBirth\": \"<string>\",\n \"subscriberFirstName\": \"<string>\",\n \"subscriberLastName\": \"<string>\",\n \"subscriberMemberId\": \"<string>\",\n \"serviceTypeCodes\": [\n \"<string>\"\n ],\n \"encounterDateOfService\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v2/clearinghouse/check-eligibility")
.header("Content-Type", "application/json")
.body("{\n \"tradingPartnerServiceId\": \"<string>\",\n \"providerName\": \"<string>\",\n \"providerIdentifier\": \"<string>\",\n \"subscriberDateOfBirth\": \"<string>\",\n \"subscriberFirstName\": \"<string>\",\n \"subscriberLastName\": \"<string>\",\n \"subscriberMemberId\": \"<string>\",\n \"serviceTypeCodes\": [\n \"<string>\"\n ],\n \"encounterDateOfService\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/clearinghouse/check-eligibility")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"tradingPartnerServiceId\": \"<string>\",\n \"providerName\": \"<string>\",\n \"providerIdentifier\": \"<string>\",\n \"subscriberDateOfBirth\": \"<string>\",\n \"subscriberFirstName\": \"<string>\",\n \"subscriberLastName\": \"<string>\",\n \"subscriberMemberId\": \"<string>\",\n \"serviceTypeCodes\": [\n \"<string>\"\n ],\n \"encounterDateOfService\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "eligibility": "<unknown>"
}
{
"error": "<string>",
"message": "<string>",
"statusCode": 123,
"details": {}
}
{
"error": "<string>"
}

Body

application/json
tradingPartnerServiceId
string
required

The trading partner service ID

providerName
string
required

The provider name.

providerIdentifier
string
required

The provider identifier. This is usually your NPI.

subscriberDateOfBirth
string
required

The date of birth of the subscriber.

subscriberFirstName
string
required

The first name of the subscriber.

subscriberLastName
string
required

The last name of the subscriber.

subscriberMemberId
string
required

The member ID of the subscriber.

serviceTypeCodes
string[]
required

The service type codes.

encounterDateOfService
string

Optional date of service (YYYY-MM-DD). When omitted, the payer defaults to the current date in their timezone. Stedi recommends omitting this field when checking eligibility for today.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Successfully checked eligibility, returns the eligibility details from the payer.

eligibility
any