Add New Member

post

https://clientuatgateway.rxsense.com/core/api/member/add-new-member

Creates a new member eligibility record in RxIQ Enterprise. The group must exist in the system.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

FirstName

string

required

length ≥ 1

Member's first name. Must not be empty.

MiddleInitial

string

length ≤ 1

Member's middle initial.

LastName

string

required

length ≥ 1

Member's last name. Must not be empty.

SuffixTypeId

integer

enum

1=Jr., 2=Sr., 3=2nd, 4=II, 5=III, 6=IV, 7=V.

Allowed:

Gender

string

enum

required

Member's gender: 0=Not Specified, 1=Male, 2=Female, 3=Non-Binary.

Allowed:

DateOfBirth

date

required

Member's date of birth (YYYY-MM-DD). Must not be future date or before 1900-01-01.

PersonalId

string

length ≤ 50

Member's personal identifier.

RelationshipTypeId

integer

enum

required

0=Not Specified, 1=Cardholder, 2=Spouse, 3=Child, 4=Other, 5=Student, 6=Disabled Dependent, 7=Adult Dependent, 8=Significant Other.

PersonCode

string

001=Cardholder, 002=Spouse, 003-999=Dependent. Must be between 0 and 999.

MemberCode

string

Unique member code. Valid values: empty string or EXC.

SpecialPricingStartDate

date

Start date for special pricing (YYYY-MM-DD).

SpecialPricingEndDate

date

End date for special pricing (YYYY-MM-DD). Must be used with SpecialPricingStartDate.

CardHolderId

string

required

length between 4 and 20

Unique identifier for the cardholder.

EffectiveStartDate

date

required

Effective start date (YYYY-MM-DD). Must be >= DateOfBirth.

EffectiveEndDate

date

Effective end date (YYYY-MM-DD). Must be later than EffectiveStartDate if provided.

string

Member's email address.

Phone

string

Member's phone number.

IsDependent

boolean

required

Indicates if the member is a dependent.

IsEmployee

boolean

Indicates if the member is an employee.

COBIndicatorTypeId

integer

enum

required

COB indicator: 0=Not Specified, 1=Primary, 2=Secondary, 3=Tertiary.

Allowed:

AlternateIds

array of strings

length ≤ 5

Multiple alternate identifiers (max 5). Each ID: 4-20 characters.

AlternateIds

GroupNumber

string

required

length ≥ 1

The unique number of the group.

GroupId

integer

required

The unique identifier of the group. Must exist in the system.

OtherPayerBin

string

length between 6 and 8

BIN for the other payer (6-8 numeric characters).

OtherPayerCardHolderId

string

length between 4 and 20

Cardholder ID for the other payer (4-20 characters).

OtherPayerEffectiveDate

date

Effective date for the other payer. Must be <= OtherPayerTerminationDate.

OtherPayerGroup

string

length ≤ 20

Group associated with the other payer.

OtherPayerOrder

integer

1 to 3

Order of the other payer coverage (1-3).

OtherPayerPcn

string

length ≤ 10

PCN for the other payer.

OtherPayerTerminationDate

date

Termination date for the other payer. Must be >= OtherPayerEffectiveDate.

Headers

Authorization

string

required

X-Api-Key

string

required

Content-Type

string

required

Defaults to application/json

Responses

400

Bad request (validation error or group not found).

401

Unauthorized.

200Member created successfully.