GET
/
enrollments
/
{enrollmentId}
This is a beta endpoint. We may make backwards incompatible changes.

This endpoint allows you to retrieve details for the specified enrollment request.

Authorizations

Authorization
string
headerrequired

A Stedi API Key for authentication.

Path Parameters

enrollmentId
string
required

The Stedi-assigned identifier for the enrollment you want to retrieve.

Response

200 - application/json
id
string
required

The Stedi-assigned identifier for the enrollment request.

primaryContact
object
required

The contact information for the provider or the entity completing the enrollment on the provider's behalf. Either organizationName or firstName and lastName are required. Payers may use this information to contact the provider or their representative directly regarding the status of the enrollment.

transactions
object
required

The type of transactions included in the enrollment.

userEmail
string
required

The email address of the user submitting the enrollment. This email will be used by Stedi staff to provide updates and communicate about the enrollment's progress. It is distinct from the primary contact's email, which is used by the payer to contact the provider directly.

provider
object
required

Information about the provider enrolling with the payer.

payer
object
required

Information about the payer the provider is enrolling with.

createdAt
string

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

updatedAt
string

The date and time when the enrollment was updated.

submittedAt
string

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.

status
enum<string>

The status of the enrollment. You can submit enrollments with either DRAFT or SUBMITTED status. However, once an enrollment is set to SUBMITTED status, only Stedi can set or update this property.

  • 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.
  • 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.
Available options:
DRAFT,
SUBMITTED,
PROVISIONING,
LIVE
reason
string

Reasons why the enrollment request is still in PROVISIONING status or may take additional time to process. 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_note
string

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

Was this page helpful?