Retrieve Enrollment
Retrieves an enrollment request by its ID. This operation returns the complete enrollment details including provider and payer information.
/enrollments/{enrollmentId}
This endpoint retrieves details for the specified transaction enrollment.
A Stedi API Key for authentication.
Path Parameters
The Stedi-assigned identifier for the enrollment you want to retrieve.
Response
GetEnrollment 200 response
The Stedi-assigned identifier for the enrollment request.
Contact information for the primary provider contact.
The date and time when the enrollment was created within Stedi.
- Format:
date-time
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
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
The history of updates to this enrollment, such as status changes. This property is experimental and may change in the future.
Documents associated with this enrollment, such as signed enrollment forms. This list doesn't include deleted documents.
Each document object contains metadata such as the document's name, status, and timestamps for creation and last update.
The type of transactions included in the enrollment.
Whether 270 eligibility checks are included in the enrollment.
Whether 276 claim status requests are included in the enrollment.
Whether 837P professional claims are included in the enrollment.
Whether 837I institutional claims are included in the enrollment.
Whether 837D dental claims are included in the enrollment.
Whether 835 Electronic Remittance Advice (ERAs) are included in the enrollment.
Whether solicited claim attachments are included in the enrollment.
Whether unsolicited claim attachments are included in the enrollment.
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.
- Pattern:
^\S+@\S+\.\S+$
- Minimum length:
5
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.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.
DRAFT
SUBMITTED
PROVISIONING
LIVE
REJECTED
The source of this enrollment.
API
UI
IMPORT
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
Tasks associated with this enrollment representing work that needs to be completed. Each task has a responsible party and specific definition.
Information about the provider enrolling with the payer.
Information about the payer the provider is enrolling with.
curl --request GET \
--url "https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}" \
--header "Authorization: <api_key>"
fetch("https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}", {
headers: {
"Authorization": "<api_key>"
}
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}"
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://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}"
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://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}"))
.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();
}
{
"message": "string",
"fieldList": [
{
"path": "string",
"message": "string"
}
]
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}