Put Provider
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
The GUID generated by the Identity Management System for this person.
Path Parameters
The public GUID (PayeeExternal_guid) identifying the provider record to update. Never exposes the internal payee_id.
Body Parameters
Whether the provider is accessible/active for the participant.
Required — send true to keep active, false to deactivate.
The participant's account number with the provider.
Optional — send null (or omit) to clear the existing value.
Max 32 characters; allowed: letters, digits, spaces, and , . -.
Provider address line 1. Required; max 128 characters.
Serialized as address_line1 by the global SnakeCaseLower naming policy.
Provider address line 2. Optional; max 128 characters.
Send null (or omit) to clear the existing value.
Provider address line 3. Optional; max 128 characters.
Send null (or omit) to clear the existing value.
Provider city. Required; max 128 characters.
Two-character US state/territory code (e.g., "AL").
Required; must be an active code from the state-codes list.
The pattern only checks shape — the service validates against the active list and rejects unknown codes with 400.
Provider postal/zip code. Required; must match ^\d{5}(-\d{4})?$.
Response
Provider successfully updated.
Response Attributes
The public identifier for the payee — the GUID from dbo.PayeeExternal (PayeeExternal_guid). This is returned instead of the internal payee_id primary key to avoid exposing internal IDs.
The display name of the provider.
The account number associated with the provider.
First line of the provider's mailing address.
Second line of the provider's mailing address.
Third line of the provider's mailing address.
City of the provider's mailing address.
State/province code of the provider's mailing address.
ZIP/postal code of the provider's mailing address.
Whether the provider record is accessible/active.
External provider identifier string (e.g. NPI).
Provider Tax Identification Number.
Invalid request body or missing required fields.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized. Authentication failed or identity could not be verified.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden. Person not authorized or identity could not be verified.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Provider not found.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal server error.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: