Retrieve Payer

Retrieve a single payer record by its Stedi payer ID.

GET/payer/{stediId}

You can use this endpoint to retrieve a specific payer record with the Stedi payer ID (stediId). You can find the Stedi payer ID for any supported payer in the Payer Network. Note that you must supply the Stedi payer ID - this endpoint doesn't support querying with the primary payer ID or payer ID aliases.

The payer record includes the payer's names, aliases, and supported use cases (medical, dental, or vision). It also contains supported transaction types and specifies whether transaction enrollment is required.

Authorizations

Authorization

RequiredHeader

A Stedi API Key for authentication.

Path Parameters

stediId

StringRegex pattern: ^[A-Z]{5}$

The Stedi payer ID, a unique identifier Stedi assigns to each payer that will never change. You can find the Stedi payer ID for any supported payer in the Payer Network.

This must be the Stedi payer ID - querying with the primary payer ID or payer ID aliases isn't supported.

Response

application/json

GetPayerRecord 200 response

payer

ObjectRequired

The payer record matching the provided Stedi payer ID. The record includes the payer's display name and aliases as well as supported transaction types and details about the payer's transaction enrollment process.

Show attributes

aliases

payer.aliases

Array of StringsRequired

Alternative IDs associated with a payer. If a payer changes their primaryPayerId, aliases allow you to continue sending transactions to the payer using the old ID uninterrupted.

avatarUrl

payer.avatarUrl

String

A URL pointing to an image file (.png, .jpeg, or .jpg) with the payer's logo. This is the same logo Stedi displays in the Payer Network. You can use this property to display payer logos in your system or application.

This property is only returned when a payer logo is available.

coverageTypes

payer.coverageTypes

Array of Strings

A list of insurance coverage types that indicates whether this payer supports transactions for medical coverage, dental coverage, vision coverage, or a combination of these. For example: ["medical"] or ["medical", "dental"].

When this array isn't in the response, it means Stedi hasn't classified the payer's coverage types yet, not that the payer doesn't support any coverage types.

Possible values

medical

dental

vision

displayName

payer.displayName

StringRequired

The payer's business name, such as Cigna or Aetna. This is the name most commonly used to identify the payer.

employerIdentificationNumbers

payer.employerIdentificationNumbers

Array of Strings

Employer Identification Numbers (EINs) associated with this payer.

enrollment

payer.enrollment

Object

Details about the transaction enrollment process for this payer, if available. This object may not be returned for some payers.

Show attributes

ptanRequired

payer.enrollment.ptanRequired

Boolean

Whether a PTAN (Provider Transaction Access Number) is required for transaction enrollment.

The Provider Transaction Access Number (PTAN) is a Medicare-issued number given to providers upon enrollment with Medicare. This number is usually six digits and is assigned based on the type of service and the location of the provider. Upon enrollment, Medicare Administrating Contracting (MAC) providers should receive their assigned PTAN number in their approval letter.

transactionEnrollmentProcesses

payer.enrollment.transactionEnrollmentProcesses

Object

Enrollment details for specific transaction types.

Stedi only returns this object when information about the enrollment process is available for one or more transaction types. When this object isn't included in the response, it doesn't mean no transaction types require enrollment. Refer to the transactionSupport object for details about which transaction types require enrollment.

Show attributes

claimPayment

payer.enrollment.transactionEnrollmentProcesses.claimPayment

Object

Details about the enrollment process for Electronic Remittance Advice (ERAs) with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.claimPayment.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.claimPayment.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

claimStatusInquiry

payer.enrollment.transactionEnrollmentProcesses.claimStatusInquiry

Object

Details about the enrollment process for real-time claim status requests with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.claimStatusInquiry.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.claimStatusInquiry.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

coordinationOfBenefits

payer.enrollment.transactionEnrollmentProcesses.coordinationOfBenefits

Object

Details about the enrollment process for coordination of benefits (COB) checks with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.coordinationOfBenefits.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.coordinationOfBenefits.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

dentalClaim

payer.enrollment.transactionEnrollmentProcesses.dentalClaim

Object

Details about the enrollment process for dental claim submission with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.dentalClaim.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.dentalClaim.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

eligibilityInquiry

payer.enrollment.transactionEnrollmentProcesses.eligibilityInquiry

Object

Details about the enrollment process for eligibility checks with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.eligibilityInquiry.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.eligibilityInquiry.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

institutionalClaim

payer.enrollment.transactionEnrollmentProcesses.institutionalClaim

Object

Details about the enrollment process for institutional claim submission with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.institutionalClaim.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.institutionalClaim.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

professionalClaim

payer.enrollment.transactionEnrollmentProcesses.professionalClaim

Object

Details about the enrollment process for professional claim submission with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.professionalClaim.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.professionalClaim.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

unsolicitedClaimAttachment

payer.enrollment.transactionEnrollmentProcesses.unsolicitedClaimAttachment

Object

Details about the enrollment process for unsolicited claim attachments with this payer.

Show attributes

timeframe

payer.enrollment.transactionEnrollmentProcesses.unsolicitedClaimAttachment.timeframe

String

Stedi's expected timeframe for completing the transaction enrollment process. INSTANT indicates that the enrollment will be in LIVE status within minutes of submitting the request.

Possible values

INSTANT

HOURS

DAYS

WEEKS

type

payer.enrollment.transactionEnrollmentProcesses.unsolicitedClaimAttachment.type

String

Whether transaction enrollment is single or multi-step.

ONE_CLICK indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.
MULTI_STEP indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.

Possible values

ONE_CLICK

MULTI_STEP

names

payer.names

Array of StringsRequired

Alternative names associated with a payer. These additional names help you search for and identify payers using the name most familiar to your organization.

operatingStates

payer.operatingStates

Array of Strings

A list of US state codes, territories, or NATIONAL that indicates the geographic regions where this payer operates. For example: ["CA", "OR"] for a regional payer, or ["NATIONAL"] for a payer that operates throughout the entire United States.

When this array isn't in the response, it means Stedi hasn't classified the payer's operating states yet.

Possible values

AL

AK

AZ

AR

CA

parentPayerGroupId

payer.parentPayerGroupId

String

The payer's parent payer group entity. This is metadata Stedi uses internally. It doesn't necessarily relate to the payer's enrollment process or other capabilities.

primaryPayerId

payer.primaryPayerId

StringRequired

The most commonly used ID for a payer. This value often corresponds to the name the payer uses internally and provides to patients on member ID cards.

stediId

payer.stediId

StringRequired

A unique ID that Stedi assigned to this payer and uses internally for routing requests. This ID will not change even if the primaryPayerId is updated.

transactionSupport

payer.transactionSupport

ObjectRequired

Whether the following transaction types are supported: 270 eligibility checks, 276 claim status requests, 837 professional claims, and 835 ERAs (claim payments). If the value is ENROLLMENT_REQUIRED, Stedi supports the transaction type, but you must enroll with the payer first.

Show attributes

claimPayment

payer.transactionSupport.claimPayment

StringRequired

Whether you can receive 835 Electronic Remittance Advice (ERA) transactions from this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

claimStatus

payer.transactionSupport.claimStatus

StringRequired

Whether you can send 276 claim status requests to this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

claimSubmission

payer.transactionSupport.claimSubmission

StringRequiredDeprecated

Whether you can send 837 professional claims to this payer. This shape is deprecated since 2024-11-13: This claimSubmission property is deprecated and will be removed in a future release. Instead, use the professionalClaimSubmission property.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

coordinationOfBenefits

payer.transactionSupport.coordinationOfBenefits

StringRequired

Coordination of Benefits (COB) support.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

dentalClaimSubmission

payer.transactionSupport.dentalClaimSubmission

StringRequired

Whether you can send 837p dental claims to this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

eligibilityCheck

payer.transactionSupport.eligibilityCheck

StringRequired

Whether you can send 270 eligibility checks to this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

institutionalClaimSubmission

payer.transactionSupport.institutionalClaimSubmission

StringRequired

Whether you can send 837i institutional claims to this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

professionalClaimSubmission

payer.transactionSupport.professionalClaimSubmission

StringRequired

Whether you can send 837p professional claims to this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

unsolicitedClaimAttachment

payer.transactionSupport.unsolicitedClaimAttachment

StringRequired

Whether you can send unsolicited claim attachments to this payer.

Possible values

SUPPORTED

NOT_SUPPORTED

ENROLLMENT_REQUIRED

urls

payer.urls

Object

URLs associated with this payer, such as their website. This object is only returned when URL information is available for the payer.

Show attributes

website

payer.urls.website

String

The payer's website URL.

curl --request GET \
  --url "https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}" \
  --header "Authorization: <api_key>"

curl --request GET \  --url "https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}" \  --header "Authorization: <api_key>"

fetch("https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

fetch("https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}", {  headers: {    "Authorization": "<api_key>"  }})

package main

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

func main() {
  url := "https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

package mainimport (  "fmt"  "net/http"  "io/ioutil")func main() {  url := "https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}"  req, _ := http.NewRequest("GET", url, nil)  req.Header.Add("Authorization", "<api_key>")  res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}

import requests

url = "https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

import requestsurl = "https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}"response = requests.request("GET", url, headers = {  "Authorization": "<api_key>"})print(response.text)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}"))
  .header("Authorization", "<api_key>")
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;HttpClient client = HttpClient.newBuilder()  .connectTimeout(Duration.ofSeconds(10))  .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()  .uri(URI.create("https://healthcare.us.stedi.com/2024-04-01/payer/{stediId}"))  .header("Authorization", "<api_key>")  .GET()  .build();try {  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());  System.out.println("Status code: " + response.statusCode());  System.out.println("Response body: " + response.body());} catch (Exception e) {  e.printStackTrace();}

{
  "payer": {
    "aliases": [
      "10048",
      "1406",
      "5501",
      "84980",
      "CB900",
      "DX900",
      "G84980",
      "SB900",
      "TXBCBS",
      "TXBLS"
    ],
    "avatarUrl": "https://prod-payer-avatars.payers.us.stedi.com/QDTRP/avatar.png?v=1762425540481",
    "coverageTypes": [
      "dental",
      "medical",
      "vision"
    ],
    "displayName": "Blue Cross Blue Shield of Texas",
    "enrollment": {
      "ptanRequired": false,
      "transactionEnrollmentProcesses": {
        "claimPayment": {
          "timeframe": "WEEKS",
          "type": "ONE_CLICK"
        }
      }
    },
    "names": [
      "Blue Cross Blue Shield Texas Medicaid STAR CHIP",
      "Blue Cross Blue Shield Texas Medicaid STAR Children's Health Insurance Program",
      "Blue Cross Blue Shield of Texas",
      "Bryan Independent School",
      "Federal Employee Program Texas (FEP)",
      "Health Maintenance Organization Blue",
      "Health Maintenance Organization Blue Texas",
      "Healthcare Benefits",
      "Rio Grande",
      "Walmart (BlueCard Carriers)"
    ],
    "operatingStates": [
      "CT",
      "IL",
      "NM",
      "TX",
      "UT"
    ],
    "parentPayerGroupId": "DKCAG",
    "primaryPayerId": "84980",
    "stediId": "QDTRP",
    "transactionSupport": {
      "claimPayment": "ENROLLMENT_REQUIRED",
      "claimStatus": "SUPPORTED",
      "claimSubmission": "SUPPORTED",
      "coordinationOfBenefits": "SUPPORTED",
      "dentalClaimSubmission": "SUPPORTED",
      "eligibilityCheck": "SUPPORTED",
      "institutionalClaimSubmission": "SUPPORTED",
      "professionalClaimSubmission": "SUPPORTED",
      "unsolicitedClaimAttachment": "NOT_SUPPORTED"
    },
    "urls": {
      "website": "https://www.bcbstx.com"
    }
  }
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

Retrieve Payer

Authorizations

Path Parameters

Response

Retrieve a payer record