Sign in

v1

latestOpenAPI 3.1.02026-07-1382339.6 KB
Internal

Get provider details

Returns base URL, provider and user details, environment, validation, and GlobalProviderId. Client ID and API key are required. At least one of ProviderTaxId, VendorId, or GlobalProviderId is required; you may send more than one if every value resolves to the same agency in HHA (otherwise the request is rejected). Environment and HHA session use ClientMappings.Env for the resolved agency. AppVersionId is optional; when omitted, BaseUrl, ProviderVersion, and ProviderMinorVersion are null; ProviderId is the resolved VendorID (same as Validation.VendorID).

get/v1/internal/provider

Query parameters

ClientIdstring required

Client ID (mandatory)

Client ID (mandatory)

XApiKeystring required

API key (mandatory)

API key (mandatory)

ProviderTaxIdstring nullable

Federal tax number (numeric). One of ProviderTaxId, VendorId, or GlobalProviderId required.

Federal tax number (numeric). One of ProviderTaxId, VendorId, or GlobalProviderId required.

VendorIdinteger nullable

HHA VendorID / agency id. One of ProviderTaxId, VendorId, or GlobalProviderId required.

HHA VendorID / agency id. One of ProviderTaxId, VendorId, or GlobalProviderId required.

GlobalProviderIdstring uuid nullable

dbo.Vendors.GlobalProviderId (UUID). One of ProviderTaxId, VendorId, or GlobalProviderId required.

dbo.Vendors.GlobalProviderId (UUID). One of ProviderTaxId, VendorId, or GlobalProviderId required.

AppVersionIdinteger[] nullable

One or more app version IDs (optional; default [35]) for URL lookup.

One or more app version IDs (optional; default [35]) for URL lookup.

Response

Successful Response

Messagestring
ClientIdstring
XApiKeystring
BaseUrlstring nullable
ProviderVersionnumber nullable
ProviderMinorVersionnumber nullable
ProviderIdinteger nullable
ProviderTaxIdstring nullable
GlobalProviderIdstring uuid nullable
UserIdinteger
UserNamestring
Environmentstring
Validationobject