Retrieve Provider

Retrieves a provider record by its ID. This operation returns the complete provider details including contact information.

GET /providers/{providerId}

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

This endpoint allows you to retrieve details for the specified provider.

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Path Parameters

providerId · string

The unique ID Stedi assigned to the provider when it was created in the system.

Response

application/json

GetProvider 200 response

id · string · required

A unique identifier Stedi assigns to this provider.

createdAt · string

The date and time Stedi created the provider record.

• Format: date-time

updatedAt · string

The date and time Stedi last updated the provider record.

• Format: date-time

npi · string · required

The provider's National Provider Identifier (NPI). This is a 10-digit number that is unique to the provider. Note that each provider record must have a unique NPI within Stedi - you cannot create a provider with an NPI that is already in use.

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

taxIdType · string · required

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

Possible values

EIN

SSN

taxId · string · required

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.

• Pattern: ^\d{9}$

name · string · required

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

contacts · array<object>

Either organizationName or firstName and lastName are required.

contacts[]. organizationName · string

The contact's business name.

contacts[]. firstName · string

The contact's first name.

contacts[]. lastName · string

The contact's last name.

contacts[]. email · string · required

The contact's email address.

• Pattern: ^\S+@\S+\.\S+$
• Minimum length: 5

contacts[]. phone · string · required

The contact's phone number, starting with the area code and formatted with dashes as separators. For example, 555-555-5555.

• Minimum length: 8

contacts[]. streetAddress1 · string · required

The contact's street address, including the street number, name, and any suite or apartment number.

• Minimum length: 5

contacts[]. streetAddress2 · string

The contact's street address continued.

contacts[]. city · string · required

The contact's city.

• Minimum length: 2

contacts[]. zipCode · string · required

The contact's five-digit ZIP code.

• Minimum length: 5

contacts[]. state · string · required

The contact's two-letter state abbreviation. For example, PA, or MD.

• Minimum length: 2

cURL

curl --request GET \
  --url "https://enrollments.us.stedi.com/2024-09-01/providers/{providerId}" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://enrollments.us.stedi.com/2024-09-01/providers/{providerId}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://enrollments.us.stedi.com/2024-09-01/providers/{providerId}"

  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))
}

Python

import requests

url = "https://enrollments.us.stedi.com/2024-09-01/providers/{providerId}"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

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/providers/{providerId}"))
  .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();
}

200

{
  "createdAt": "2024-11-18T17:39:52.406Z",
  "id": "10334e76-f073-4b5d-8984-81d8e5107857",
  "name": "BDQ Dental Inc",
  "npi": "1999999992",
  "taxId": "555123456",
  "taxIdType": "EIN",
  "updatedAt": "2024-11-18T17:39:52.406Z",
  "contacts": [
    {
      "organizationName": "",
      "firstName": "Bob",
      "lastName": "Dentist",
      "email": "bob@fortdental.center",
      "phone": "555-123-213342",
      "streetAddress1": "123 Some Str",
      "city": "Chevy Chase",
      "zipCode": "20814",
      "state": "MD"
    },
    {
      "organizationName": "",
      "firstName": "Tom",
      "lastName": "Dentist",
      "email": "tom@fortdental.center",
      "phone": "555-123-213342",
      "streetAddress1": "123 Some Str",
      "city": "Chevy Chase",
      "zipCode": "20814",
      "state": "MD"
    }
  ]
}

400

{
  "message": "string",
  "fieldList": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

401

{
  "message": "string",
  "code": "string"
}

403

{
  "message": "string",
  "code": "string"
}

404

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "code": "string"
}