v50

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-311565244.2 KB

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

post/enrollments

Request body

providerTransactionAccessNumberstring

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.

reasonstring

This shape is deprecated since 2025-10-07: Only Stedi can set or update this property, and it will be removed in a future release.

requestedEffectiveDatestring

The requested effective date for the enrollment in YYYYMMDD format. This is the date you'd like the enrollment to take effect with the payer. For example, setting this to 20260601 for an 835 Electronic Remittance Advice (ERAs) enrollment means you want to start receiving ERAs through Stedi on that date.

Stedi processes enrollments accordingly, but can't guarantee that the enrollment will be effective on this exact date.

  • You can submit today's date or a future date up to 6 months from today.
  • If not set for draft enrollments, this property remains empty.
  • If not set for submitted enrollments, Stedi defaults to the enrollment's submission date.
  • If you include this property for a payer that doesn't support requested effective dates, Stedi rejects the request with an HTTP 400 error.
source'API' | 'UI' | 'IMPORT' | 'AUTO_ENROLLMENT' | 'AUTOMATED_TASK'

The source of the enrollment.

status'DRAFT' | 'SUBMITTED' | 'STEDI_ACTION_REQUIRED'

The enrollment's status when it is first created. You can create enrollments in either DRAFT or STEDI_ACTION_REQUIRED status. The default status is DRAFT if not specified. When you're ready for Stedi to begin processing the enrollment, set the status to STEDI_ACTION_REQUIRED. Once an enrollment is set to STEDI_ACTION_REQUIRED, only Stedi can set or update its status.

userEmailstring required

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.
  • For automatic enrollment requests, Stedi sets this to the oldest account member with the Admin role.

Response

CreateEnrollment 200 response

createdAtstring date-time required

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

idstring required

The Stedi-assigned identifier for the enrollment request.

lastEraReceivedAtstring date-time

The timestamp of the most recent 835 ERA (Electronic Remittance Advice) Stedi received for this enrollment, based on the enrollment's payer ID, provider NPI, and provider tax ID. Stedi automatically updates this property for each new ERA.

  • This property is only returned for ERA enrollments in LIVE status with at least one matching ERA from the payer.
  • If this timestamp doesn't match your expected timeline for ERA processing, there may be an upstream issue. Contact Stedi support for assistance.
providerTransactionAccessNumberstring

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.

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.

requestedEffectiveDatestring

The requested effective date for the enrollment in YYYYMMDD format. This is the date the submitter would like the enrollment to take effect with the payer. If not provided during submission, Stedi defaults to the enrollment's submission date.

Not all payers support requested effective dates. Stedi can't guarantee that the enrollment will be effective with the payer on this exact date.

source'API' | 'UI' | 'IMPORT' | 'AUTO_ENROLLMENT' | 'AUTOMATED_TASK'

The source of the enrollment.

status'DRAFT' | 'SUBMITTED' | 'PROVISIONING' | 'LIVE' | 'REJECTED' | 'CANCELED' | 'STEDI_ACTION_REQUIRED' | 'PROVIDER_ACTION_REQUIRED'

The status of the enrollment. You can submit enrollments with either DRAFT or STEDI_ACTION_REQUIRED status - the default is DRAFT if not included. Set this to STEDI_ACTION_REQUIRED when you're ready for Stedi to begin processing the enrollment. Once an enrollment is STEDI_ACTION_REQUIRED, only Stedi can set or update its status.

statusLastUpdatedAtstring date-time required

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.

submittedAtstring 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 STEDI_ACTION_REQUIRED, submittedAt is updated to the submission time. If the enrollment was created and submitted immediately, the submittedAt time will be equal or close to the createdAt time.

updatedAtstring date-time required

The date and time when the enrollment was updated.

userEmailstring required

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.
  • For automatic enrollment requests, Stedi sets this to the oldest account member with the Admin role.