Create 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 UUID of the participant (maps to Individual.IndividualSystemId).
Body Parameters
The display name of the provider. Required; max 100 characters.
The account number associated with this provider. Optional; max 32 characters.
First line of the provider's mailing address. Required; max 128 characters.
Second line of the provider's mailing address. Optional; max 128 characters.
Third line of the provider's mailing address. Optional; max 128 characters.
City of the provider's mailing address. Required; max 128 characters.
Two-letter US state/territory code. Required; must be a valid US state or territory abbreviation.
ZIP/postal code. Required; must match ^\d{5}(-\d{4})?$.
Whether this provider is accessible/active. Defaults to true.
External provider identifier (e.g. NPI). Optional; max 100 characters.
Provider Tax Identification Number. Optional; max 100 characters.
Response
Provider created successfully.
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.
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.
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: