Create Provider

Creates a new provider record. Providers must be created before they can be enrolled with payers.

POST/providers

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

This endpoint allows you to create a provider record with the details required for transaction enrollment.

  1. Call this endpoint with the provider's details.
  2. The endpoint returns the created provider record, including the provider id, which you'll need when creating enrollment requests.

You can now add the provider to one or more transaction enrollment requests.

All providers you create through this endpoint are available on the Providers page for you to review and manage.

Contacts

You can add one or more contacts to a provider record. 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
npistringrequired

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.

  • Pattern: ^[0-9]{10}$
taxIdTypestringrequired

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

Possible values
EIN
SSN
taxIdstringrequired

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.

  • Pattern: ^\d{9}$
namestringrequired

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.

  • Minimum length: 5
contactsarray<object>

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

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.

contacts[].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
contacts[].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.

contacts[].citystringrequired

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

  • Minimum length: 2
contacts[].zipCodestringrequired

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

  • Minimum length: 5
contacts[].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

Response

application/json

CreateProvider 200 response

idstringrequired

A unique identifier Stedi assigns to this provider.

createdAtstring

The date and time Stedi created the provider record.

  • Format: date-time
updatedAtstring

The date and time Stedi last updated the provider record.

  • Format: date-time
npistringrequired

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.

  • Pattern: ^[0-9]{10}$
taxIdTypestringrequired

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

Possible values
EIN
SSN
taxIdstringrequired

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.

  • Pattern: ^\d{9}$
namestringrequired

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.

  • Minimum length: 5
contactsarray<object>

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

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.

contacts[].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
contacts[].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.

contacts[].citystringrequired

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

  • Minimum length: 2
contacts[].zipCodestringrequired

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

  • Minimum length: 5
contacts[].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