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 or dental). It also contains supported transaction types and specifies whether transaction enrollment is required.

Authorizationstringrequiredheader

A Stedi API Key for authentication.

Path Parameters

stediIdstring

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.

  • Pattern: ^[A-Z]{5}$

Response

application/json

GetPayerRecord 200 response

payerobjectrequired

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
payer.aliasesarray<string>required

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.

payer.coverageTypesarray<string>

A list of insurance coverage types that indicates whether this payer supports transactions for medical coverage, dental coverage, or both. 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
payer.displayNamestringrequired

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

Employer Identification Numbers (EINs) associated with this payer.

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

Show attributes

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.

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

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

Show attributes

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

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

Show attributes

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

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

Show attributes

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

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

Show attributes

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

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

Show attributes

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

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

Show attributes

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

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

Show attributes

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

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

Show attributes

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
payer.namesarray<string>required

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

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.

payer.primaryPayerIdstringrequired

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.

payer.stediIdstringrequired

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.

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

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

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

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

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

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

Coordination of Benefits (COB) support.

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

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

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

Whether you can send 270 eligibility checks to this payer.

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

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

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

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

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED

Whether you can send unsolicited claim attachments to this payer.

Possible values
SUPPORTED
NOT_SUPPORTED
ENROLLMENT_REQUIRED