Create Account

post

https://s3partnerapi-staging.solutran.com/2.2/accounts

Creates a new account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The account information to create.

Request body for creating a new household account.

clientRequestId

string | null

Optional caller-supplied correlation ID. Returned in response headers and logs for end-to-end tracing.

updatedUser

string | null

Username or system identifier of the user performing the update. Used for audit trail.

int64

Internal S3 account identifier. Populated on response; ignored on POST.

programId

int64

The S3 program the account belongs to.

clientAccountId

string

required

length between 1 and 100

Your system's unique identifier for this account. Required. Max 100 characters.

dateOfBirth

string | null

Member date of birth. Format: YYYY-MM-DD.

string | null

Member email address. Max 50 characters.

firstName

string | null

Member first name. Max 50 characters.

lastName

string | null

Member last name. Max 50 characters.

middleInitial

string | null

Member middle initial. Max 1 character.

languageCode

string | null

IETF language tag (e.g. en-US). Max 5 characters.

phone

string | null

^$?([0-9]{3})$?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$

Primary phone number. Format: ###-###-#### or (###) ###-####.

secondaryPhone

string | null

^$?([0-9]{3})$?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$

Secondary / alternate phone number. Same format rules as Phone.

startDate

date-time

Date the account becomes active. Must be before EndDate. Defaults to today if in the past.

endDate

date-time

Date the account expires. Must be a future date.

status

string | null

Account status. Typically Active or Inactive.

userDefined1

string | null

Client-defined custom field 1. Max 50 characters.

userDefined2

string | null

Client-defined custom field 2. Max 50 characters.

userDefined3

string | null

Client-defined custom field 3. Max 50 characters.

userDefined4

string | null

Client-defined custom field 4. Max 50 characters.

alternateSearchKey

string | null

An additional key used to look up the account from an external system. Max 50 characters.

healthySavingsEligible

string | null

Whether the member is eligible for Healthy Savings. Accepted values: Yes, No.

crosswalkKey

string | null

Crosswalk identifier used to auto-assign the account to a subgroup based on plan year data.

addedDateTime

string | null

ISO 8601 timestamp of when the account was created. Read-only — populated by the API.

updatedDate

string | null

ISO 8601 timestamp of the last update. Read-only — populated by the API.

createEligibilityRecord

boolean

When true, an eligibility record is created alongside the account.

accessMethod

string | null

Card / digital access method. Accepted values:
01 = Digital only, 02 = Card only, 03 = Digital + Card, 04 = Visa.

address

object

Mailing address associated with an account.

subgroup

object

Subgroup assignment for an account. Supply either Id or ClientSubgroupId.

issuances

array of objects | null

One or more benefit issuances to fund at account creation time.

issuances

memberships

array of objects | null

Membership records to associate with the account at creation time.

memberships

termPrevious

boolean

When true, any previous active account for the same ClientAccountId is terminated before creating the new one.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

204

No Content

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content