Wex Health and Benefits APIs

Sections

Theme switcher

Create Provider

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Query Parameters

person_idstring Required

The UUID of the participant (maps to Individual.IndividualSystemId).

Body Parameters

namestring Required

The display name of the provider. Required; max 100 characters.

Max length
100
account_numberstring

The account number associated with this provider. Optional; max 32 characters.

Max length
32
address_line1string Required

First line of the provider's mailing address. Required; max 128 characters.

Max length
128
address_line2string

Second line of the provider's mailing address. Optional; max 128 characters.

Max length
128
address_line3string

Third line of the provider's mailing address. Optional; max 128 characters.

Max length
128
citystring Required

City of the provider's mailing address. Required; max 128 characters.

Max length
128
statestring Required

Two-letter US state/territory code. Required; must be a valid US state or territory abbreviation.

Min length
2
Max length
2
zipstring Required

ZIP/postal code. Required; must match ^\d{5}(-\d{4})?$.

Max length
10
accessibleboolean

Whether this provider is accessible/active. Defaults to true.

provider_idstring

External provider identifier (e.g. NPI). Optional; max 100 characters.

Max length
100
provider_tinstring

Provider Tax Identification Number. Optional; max 100 characters.

Max length
100

Response

201
Object

Provider created successfully.

Response Attributes

payee_idstring

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.

namestring

The display name of the provider.

account_numberstring

The account number associated with the provider.

address_line1string

First line of the provider's mailing address.

address_line2string

Second line of the provider's mailing address.

address_line3string

Third line of the provider's mailing address.

citystring

City of the provider's mailing address.

statestring

State/province code of the provider's mailing address.

zipstring

ZIP/postal code of the provider's mailing address.

accessibleboolean

Whether the provider record is accessible/active.

provider_idstring

External provider identifier string (e.g. NPI).

provider_tinstring

Provider Tax Identification Number.

400
Object

Invalid request body or missing required fields.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized. Authentication failed.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

403
Object

Forbidden. Person not authorized or identity could not be verified.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

500
Object

Internal server error.

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

Base URL

Production:

Sandbox:

Language Box

POST

/

Select
1

Response

Was this section helpful?