Update Provider

Updates an existing provider's information. Note that NPI and tax ID cannot be changed after creation.

POST/providers/{providerId}

This endpoint allows you to update information for an existing provider. For example, you may want to add an additional contact.

Please note:

  • Calling this endpoint completely overwrites the previous request record. You must provide all the information for the provider in the request, not just the properties you want to update.
  • Updating a provider record doesn't affect associated enrollments that are in SUBMITTED, PROVISIONING or LIVE status. If you need to update the provider details for an enrollment with these statuses, contact support.
Authorization
RequiredHeader

A Stedi API Key for authentication.

Path Parameters

The Stedi-assigned identifier for the provider you want to update.

Body

application/json
name
StringRequiredMin length: 5

The provider's business name. This is typically the provider's practice name, such as Dental Associates, LLC, but it can also be the provider's first and last name.

contacts
Array of Objects

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

  • Either organizationName or firstName and lastName are required.
  • 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 and 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.
Array item
organizationName
contacts[].organizationName
String

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

firstName
contacts[].firstName
String

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

lastName
contacts[].lastName
String

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

email
contacts[].email
StringRequiredRegex pattern: ^\S+@\S+\.\S+$Min length: 5

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.

phone
contacts[].phone
StringRequiredRegex pattern: ^(?:[\s().-]*\d){10}[\s().-]*$

The contact's phone number. 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.

streetAddress1
contacts[].streetAddress1
StringRequiredMin length: 5

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.

streetAddress2
contacts[].streetAddress2
String

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

city
contacts[].city
StringRequiredMin length: 2

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

zipCode
contacts[].zipCode
StringRequiredMin length: 5

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

state
contacts[].state
StringRequired

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.

Possible values
AA
AE
AK
AL
AP

Response

application/json

UpdateProvider 200 response

id
StringRequired

A unique identifier Stedi assigns to this provider.

createdAt
StringFormat: date-time

The date and time Stedi created the provider record.

updatedAt
StringFormat: date-time

The date and time Stedi last updated the provider record.

npi
StringRequiredRegex pattern: ^[0-9]{10}$

The provider's National Provider Identifier (NPI). This is a 10-digit number that is unique to the provider.

Each provider record must have a unique npi and taxId combination. For example, you can create two provider records with the same npi as long as they have different values for taxId.

taxIdType
String

The type of tax ID. Can be either an EIN - Employer Identification Number, or an SSN - Social Security Number.

Possible values
EIN
SSN
taxId
StringRegex pattern: ^\d{9}$

The provider's tax ID, as specified by taxIdType. This identifier has to be provided without any separators, such as dashes or spaces. For example 111-22-3333 is invalid but 111223333 is valid.

Each provider record must have a unique npi and taxId combination. For example, you can create two provider records with the same taxId as long as they have different values for npi.

name
StringRequiredMin length: 5

The provider's business name. This is typically the provider's practice name, such as Dental Associates, LLC, but it can also be the provider's first and last name.

contacts
Array of Objects

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

  • Either organizationName or firstName and lastName are required.
  • 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 and 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.
Array item
organizationName
contacts[].organizationName
String

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

firstName
contacts[].firstName
String

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

lastName
contacts[].lastName
String

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

email
contacts[].email
StringRequiredRegex pattern: ^\S+@\S+\.\S+$Min length: 5

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.

phone
contacts[].phone
StringRequiredRegex pattern: ^(?:[\s().-]*\d){10}[\s().-]*$

The contact's phone number. 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.

streetAddress1
contacts[].streetAddress1
StringRequiredMin length: 5

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.

streetAddress2
contacts[].streetAddress2
String

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

city
contacts[].city
StringRequiredMin length: 2

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

zipCode
contacts[].zipCode
StringRequiredMin length: 5

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

state
contacts[].state
StringRequired

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.

Possible values
AA
AE
AK
AL
AP