latestOpenAPI 3.1.02026-08-1217210199.4 KB

1684e1dda9be

public-api

Lookup Provider

Look up a provider by NPI or by name+state.

NPI mode: returns active, deactivated (with name+state search candidates seeded from the deactivated record's name), not_found, or registry_error. Sandbox organizations may receive an active mock identity when the NPI is absent from the registry. Deactivated records with no name on file return an empty candidate list — the FE prompts for manual name+state entry.

Name mode: last_name is required, first_name and state are optional. Always returns search_results (the candidate list may be empty when no match is found).

post/provider/lookup

Request body

npistring

The NPI to look up. Optional names may be included as sandbox fallback hints.

first_namestring

First name for name+state search. Optional when last_name is provided.

last_namestring

Last name for name+state search. Required for name search.

statestring

Two-letter state abbreviation. Optional in name searches.

Response

Successful Response