Create Enrollment

Creates a new transaction enrollment request. Transaction enrollment registers a provider to exchange specific transaction types with a payer.

POST/enrollments

This is a beta endpoint. We may make backwards incompatible changes.

This endpoint allows you to submit a transaction enrollment request for a specific provider. You must create one enrollment request for each transaction type. For example, you would create three separate requests to enroll a provider for 837P claims (professional), 270 real-time eligibility checks, and 835 ERAs (claim payments).

  1. Add the provider's details through either the Providers page or the Create Provider endpoint.
  2. Call this endpoint to create the enrollment request. Set the status property to DRAFT for test enrollments. Set the status property to SUBMITTED when you're ready for Stedi to begin processing the request.
  3. The endpoint returns summary information about the enrollment request.

Once the status is set to SUBMITTED, Stedi begins processing the enrollment request. You can track its progress through the Stedi portal or the API.

Contacts

You must add a contact to an enrollment request. This is where the payer will send communications about the enrollment, if needed.

  • The provider's name and address should match exactly what the payer has on file. Some payers reject enrollment requests with addresses that don't match their records.
  • However, you may want to set the phone number or email to your own contact details. Do this when you want the payer to contact you about the enrollment instead of the provider directly.
Authorizationstringrequiredheader

A Stedi API Key for authentication.

Body

application/json
transactionseligibilityCheck | claimStatus | professionalClaimSubmission | institutionalClaimSubmission | dentalClaimSubmission | claimPayment | solicitedClaimAttachment | unsolicitedClaimAttachmentrequired

The type of transactions included in the enrollment.

Whether 270 eligibility checks are included in the enrollment.

Show attributes

Whether 276 claim status requests are included in the enrollment.

Show attributes

Whether 837P professional claims are included in the enrollment.

Show attributes

Whether 837I institutional claims are included in the enrollment.

Show attributes

Whether 837D dental claims are included in the enrollment.

Show attributes

Whether 835 Electronic Remittance Advice (ERAs) are included in the enrollment.

Show attributes

Whether solicited claim attachments are included in the enrollment.

Show attributes

Whether unsolicited claim attachments are included in the enrollment.

Show attributes
primaryContactobjectrequired

The contact information for the provider. This is where the payer will send communications about the enrollment, if needed.

  • The name and address should match exactly what the payer has on file for the provider. Some payers reject enrollment requests with addresses that don't match their records.
  • If you're submitting enrollment requests on a provider's behalf, you may want to set the phone number or email to your own contact details. Do this when you want the payer to contact you about the enrollment status instead of the provider directly.
Show attributes

The contact's business name. This should match exactly what the payer has on file for the provider.

The contact's first name. This should match exactly what the payer has on file for the provider.

The contact's last name. This should match exactly what the payer has on file for the provider.

primaryContact.emailstringrequired

The contact's email address. Set this to where you want the payer to send communications regarding the enrollment. This can be different from the provider's email if needed.

  • Pattern: ^\S+@\S+\.\S+$
  • Minimum length: 5
primaryContact.phonestringrequired

The contact's phone number, starting with the area code and formatted with dashes as separators. For example, 555-555-5555. Set this to where you want the payer to direct communications regarding the enrollment. This can be different from the provider's phone number if needed.

  • Minimum length: 8

The contact's street address, including the street number, name, and any suite or apartment number. This should match exactly what the payer has on file for the provider.

  • Minimum length: 5

The contact's street address continued. This should match exactly what the payer has on file for the provider.

primaryContact.citystringrequired

The contact's city. This should match exactly what the payer has on file for the provider.

  • Minimum length: 2

The contact's five-digit ZIP code. This should match exactly what the payer has on file for the provider.

  • Minimum length: 5
primaryContact.statestringrequired

The contact's two-letter state abbreviation. For example, PA, or MD. This should match exactly what the payer has on file for the provider.

  • Minimum length: 2
userEmailstringrequired

The email address where Stedi should send updates about the enrollment. We'll use it to notify you when there are next steps and send updates on the enrollment's status.

This email address can be different from the primaryContact.email where the payer sends communications about the enrollment.

  • Pattern: ^\S+@\S+\.\S+$
  • Minimum length: 5
statusstring

The status of the enrollment. You can submit enrollments with either DRAFT or SUBMITTED status - the default is DRAFT if not included.

Set this to SUBMITTED when you're ready for Stedi to begin processing the enrollment. Once an enrollment is SUBMITTED, only Stedi can set or update its status.

  • DRAFT - You are still editing the record and it has not been submitted to Stedi.
  • SUBMITTED - You have successfully submitted the request and it is in Stedi's queue for review. Stedi won't process enrollments until they are submitted.
  • PROVISIONING - Stedi has begun the process of completing the enrollment with the payer.
  • LIVE - The enrollment process is complete, and the specified provider can begin exchanging the listed transaction types with the payer.
  • REJECTED - The payer rejected the enrollment. Common reasons for rejection include incorrect details in the request and that the provider is not credentialed with the payer. Customer support will contact you with reasons for rejection and next steps.
  • CANCELED - The enrollment has been terminated per customer or provider request.
Possible values
DRAFT
SUBMITTED
PROVISIONING
LIVE
REJECTED
sourcestring

The source of this enrollment.

Possible values
API
UI
IMPORT
reasonstring

Reasons why the enrollment request is still in PROVISIONING status, may take additional time to process, or was rejected by the payer. Only Stedi can set or update this property.

May contain extra required steps for processing that are specific to the payer. For example, perhaps the provider needs to log into an online portal and enter additional information before the enrollment can continue. Contact Stedi customer support with questions.

Internal notes about the enrollment. Only Stedi can read, set, or update this property.

This property is required for payers that require a Provider Transaction Access Number (PTAN).

The 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.

  • Pattern: ^[a-zA-Z0-9]+$
  • Required string length: 5 - 10
tasksarray<object>

Tasks associated with this enrollment representing work that needs to be completed. Each task has a responsible party and specific definition.

Array item

The party responsible for completing this task.

Possible values
PROVIDER
STEDI
tasks[].definitionfollowInstructionsrequired

The specific definition and data for this task.

Show attributes

A task that requires the responsible party to follow specific instructions.

Show attributes

Human-readable instructions for the responsible party to follow.

  • Minimum length: 1
tasks[].idstringrequired

The unique identifier for the task.

providerobjectrequired

Information about the provider enrolling with the payer. You must use the Create Provider endpoint to add the provider to Stedi before you can enroll them with one or more payers.

Show attributes
provider.idstringrequired

The Stedi-assigned identifier for the provider. The Create Provider endpoint returns this as the id property.

payerobjectrequired

Information about the payer the provider is enrolling with.

Show attributes
payer.idstringdeprecated

Use idOrAlias instead. This property will be removed in the future.

The Payer ID. This can be the primary Payer ID, the Stedi Payer ID, or any listed aliases for the payer. Visit the Payer Network for a complete list.

Response

application/json

CreateEnrollment 200 response

idstringrequired

The Stedi-assigned identifier for the enrollment request.

primaryContactobjectrequired

The contact information for the provider. This is where the payer will send communications about the enrollment, if needed.

  • The name and address should match exactly what the payer has on file for the provider. Some payers reject enrollment requests with addresses that don't match their records.
  • If you're submitting enrollment requests on a provider's behalf, you may want to set the phone number or email to your own contact details. Do this when you want the payer to contact you about the enrollment status instead of the provider directly.
Show attributes

The contact's business name. This should match exactly what the payer has on file for the provider.

The contact's first name. This should match exactly what the payer has on file for the provider.

The contact's last name. This should match exactly what the payer has on file for the provider.

primaryContact.emailstringrequired

The contact's email address. Set this to where you want the payer to send communications regarding the enrollment. This can be different from the provider's email if needed.

  • Pattern: ^\S+@\S+\.\S+$
  • Minimum length: 5
primaryContact.phonestringrequired

The contact's phone number, starting with the area code and formatted with dashes as separators. For example, 555-555-5555. Set this to where you want the payer to direct communications regarding the enrollment. This can be different from the provider's phone number if needed.

  • Minimum length: 8

The contact's street address, including the street number, name, and any suite or apartment number. This should match exactly what the payer has on file for the provider.

  • Minimum length: 5

The contact's street address continued. This should match exactly what the payer has on file for the provider.

primaryContact.citystringrequired

The contact's city. This should match exactly what the payer has on file for the provider.

  • Minimum length: 2

The contact's five-digit ZIP code. This should match exactly what the payer has on file for the provider.

  • Minimum length: 5
primaryContact.statestringrequired

The contact's two-letter state abbreviation. For example, PA, or MD. This should match exactly what the payer has on file for the provider.

  • Minimum length: 2
createdAtstringrequired

The date and time when the enrollment was created within Stedi.

  • Format: date-time
updatedAtstringrequired

The date and time when the enrollment was updated.

  • Format: date-time

The date and time when the enrollment was submitted. If the enrollment is in draft status, submittedAt is not present. When the enrollment transitions from draft to submitted, submittedAt will be updated to the submission time. If the enrollment was created and submitted immediately, submittedAt will be equal or close to createdAt.

  • Format: date-time
statusLastUpdatedAtstringrequired

The date and time when the enrollment status was last updated. This timestamp is used to track enrollment processing durations and enables filtering to identify recently changed enrollments. It automatically updates whenever an enrollment's status changes but remains unchanged during other updates.

  • Format: date-time
historyarray<object>

The history of updates to this enrollment, such as status changes. This property is experimental and may change in the future.

Array item

The status before this change occurred. This will be UNDEFINED for the enrollment's initial status after creation.

Possible values
DRAFT
SUBMITTED
PROVISIONING
LIVE
REJECTED
history[].newStatusstringrequired

The status after this change occurred.

Possible values
DRAFT
SUBMITTED
PROVISIONING
LIVE
REJECTED
history[].changedBystringrequired

The source or system that triggered this change.

history[].changedAtstringrequired

The date and time when this change occurred.

  • Format: date-time
history[].typestringrequired

The type of change that occurred.

Possible values
STATUS_CHANGE
documentsarray<object>

Documents associated with this enrollment, excluding deleted documents.

Array item
documents[].idstringrequired

The unique identifier for the document.

The enrollment ID this document is associated with.

documents[].namestringrequired

The name of the document.

The content type of the document.

The size of the document in bytes.

documents[].statusstringrequired

Indicates whether the document file has been successfully uploaded to Stedi.

Possible values
PENDING
UPLOADED
FAILED
DELETED
documents[].createdAtstringrequired

The date and time when the document was created.

  • Format: date-time
documents[].updatedAtstringrequired

The date and time when the document was last updated.

  • Format: date-time
tasksarray<object>

Tasks associated with this enrollment representing work that needs to be completed. Each task has a responsible party and specific definition.

Array item

The party responsible for completing this task.

Possible values
PROVIDER
STEDI
tasks[].definitionfollowInstructionsrequired

The specific definition and data for this task.

Show attributes

A task that requires the responsible party to follow specific instructions.

Show attributes

Human-readable instructions for the responsible party to follow.

  • Minimum length: 1
tasks[].idstringrequired

The unique identifier for the task.

transactionseligibilityCheck | claimStatus | professionalClaimSubmission | institutionalClaimSubmission | dentalClaimSubmission | claimPayment | solicitedClaimAttachment | unsolicitedClaimAttachmentrequired

The type of transactions included in the enrollment.

Whether 270 eligibility checks are included in the enrollment.

Show attributes

Whether 276 claim status requests are included in the enrollment.

Show attributes

Whether 837P professional claims are included in the enrollment.

Show attributes

Whether 837I institutional claims are included in the enrollment.

Show attributes

Whether 837D dental claims are included in the enrollment.

Show attributes

Whether 835 Electronic Remittance Advice (ERAs) are included in the enrollment.

Show attributes

Whether solicited claim attachments are included in the enrollment.

Show attributes

Whether unsolicited claim attachments are included in the enrollment.

Show attributes
userEmailstringrequired

The email address where Stedi should send updates about the enrollment. We'll use it to notify you when there are next steps and send updates on the enrollment's status.

This email address can be different from the primaryContact.email where the payer sends communications about the enrollment.

  • Pattern: ^\S+@\S+\.\S+$
  • Minimum length: 5
statusstring

The status of the enrollment. You can submit enrollments with either DRAFT or SUBMITTED status - the default is DRAFT if not included.

Set this to SUBMITTED when you're ready for Stedi to begin processing the enrollment. Once an enrollment is SUBMITTED, only Stedi can set or update its status.

  • DRAFT - You are still editing the record and it has not been submitted to Stedi.
  • SUBMITTED - You have successfully submitted the request and it is in Stedi's queue for review. Stedi won't process enrollments until they are submitted.
  • PROVISIONING - Stedi has begun the process of completing the enrollment with the payer.
  • LIVE - The enrollment process is complete, and the specified provider can begin exchanging the listed transaction types with the payer.
  • REJECTED - The payer rejected the enrollment. Common reasons for rejection include incorrect details in the request and that the provider is not credentialed with the payer. Customer support will contact you with reasons for rejection and next steps.
  • CANCELED - The enrollment has been terminated per customer or provider request.
Possible values
DRAFT
SUBMITTED
PROVISIONING
LIVE
REJECTED
sourcestring

The source of this enrollment.

Possible values
API
UI
IMPORT
reasonstring

Reasons why the enrollment request is still in PROVISIONING status, may take additional time to process, or was rejected by the payer. Only Stedi can set or update this property.

May contain extra required steps for processing that are specific to the payer. For example, perhaps the provider needs to log into an online portal and enter additional information before the enrollment can continue. Contact Stedi customer support with questions.

Internal notes about the enrollment. Only Stedi can read, set, or update this property.

This property is required for payers that require a Provider Transaction Access Number (PTAN).

The 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.

  • Pattern: ^[a-zA-Z0-9]+$
  • Required string length: 5 - 10
providerobjectrequired

Information about the provider enrolling with the payer.

Show attributes
provider.namestringrequired

The provider's name, such as Example Dental Associates, LLC.

provider.npistringrequired

The provider's National Provider Identifier (NPI). This is a 10-digit number assigned by the Centers for Medicare & Medicaid Services (CMS) to healthcare providers in the United States. It is used to identify providers in healthcare transactions.

provider.taxIdstringrequired

The provider's tax identification number (SSN or EIN). This is used to identify the provider for tax and administrative purposes.

provider.taxIdTypestringrequired

The type of tax identification number. This indicates whether the tax ID is a Social Security Number (SSN) or Employer Identification Number (EIN).

provider.idstringrequired

The Stedi-assigned identifier for the provider. The Create Provider endpoint returns this as the id property.

payerobjectrequired

Information about the payer the provider is enrolling with.

Show attributes

The payer's name, such as Cigna or UnitedHealthcare.

payer.stediPayerIdstringrequired

The unique Stedi assigned identifier for the payer.