Retrieve a provider | Collate API Documentation

Retrieves a tenant-scoped provider by NPI.

Use this endpoint to verify that a provider is available to your integration before creating an authorization.

Returns

Returns the provider. Returns 404 provider_not_found if the NPI is not registered to the authenticated organization.

AuthorizationBearer

API key passed as Authorization: Bearer <API_KEY>.

provider_npistringRequired

Provider NPI registered to the authenticated organization.

Successful Response

npistring

National Provider Identifier.

displayNamestring

Human-readable provider name.

statusstring

Provider status in the tenant catalog.

createdAtdatetime

Time when the provider was created.

updatedAtdatetime

Time when the provider was last updated.

taxIdstring or null

Provider tax ID, when configured.

metadatamap from strings to strings or integers or doubles or booleans

Tenant-defined provider metadata.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error