Member Beneficiary

Create MemberBeneficiary

Creates a new MemberBeneficiary

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

beneficiary_ID
required
string [ 1 .. 20 ] characters

Unique identifier for this beneficiary on this member.

address
string or null <= 512 characters

Primary address of the Beneficiary.

address2
string or null <= 128 characters

Address line 2 of the Beneficiary's primary address.

assignment
number or null <double>

A set amount paid to a beneficiary.

city
string or null <= 32 characters

City of the Beneficiary's primary address.

country_ID
string or null <= 8 characters

Identifier of the country of the Beneficiary's primary address.

date_Of_Birth
string or null <date-time>

Date of birth of the Beneficiary.

end_Date
string or null <date-time>

End date of the Beneficiary's status.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exclude_Interest
required
boolean

Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

first_Name
string or null <= 25 characters

First name of the Beneficiary.

last_Name
string or null <= 25 characters

Last name of the Beneficiary.

long_Name
string or null <= 512 characters

Full name of the Beneficiary.

middle_Name
string or null <= 25 characters

Middle name of the Beneficiary.

percentage
number or null <double>

Percentage of the benefit that is allotted to the associated Beneficiary.

primary_Beneficiary
boolean or null

Indicates whether the associated Beneficiary is the primary Beneficiary.

relationship
string or null <= 12 characters

Relationship of the Beneficiary to the Member.

ssn
string or null <= 32 characters

Social security number of the Beneficiary.

secondary_Beneficiary
boolean or null

This flag indicates if this beneficiary is secondary.

start_Date
string or null <date-time>

Start date of the Beneficiary's status.

state
string or null <= 2 characters

State of the Beneficiary's primary address.

tertiary_Beneficiary
boolean or null

This flag indicates if this tertiary is secondary.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

zip
string or null <= 32 characters

Zip code of the Beneficiary's primary address.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "beneficiary_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "assignment": 0.1,
  • "city": "string",
  • "country_ID": "string",
  • "date_Of_Birth": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude_Interest": true,
  • "first_Name": "string",
  • "last_Name": "string",
  • "long_Name": "string",
  • "middle_Name": "string",
  • "percentage": 0.1,
  • "primary_Beneficiary": true,
  • "relationship": "string",
  • "ssn": "string",
  • "secondary_Beneficiary": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "state": "st",
  • "tertiary_Beneficiary": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberBeneficiary

Lists all MemberBeneficiary for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries
Request samples 
Response samples 
No sample
Get MemberBeneficiary
Gets MemberBeneficiary


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}
Request samples 
Response samples 
No sample
Update MemberBeneficiary
Updates a specific MemberBeneficiary.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
beneficiary_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier for this beneficiary on this member.


 
address
string or null  <= 512 characters 
Primary address of the Beneficiary.


 
address2
string or null  <= 128 characters 
Address line 2 of the Beneficiary's primary address.


 
assignment
number or null <double> 
A set amount paid to a beneficiary.


 
city
string or null  <= 32 characters 
City of the Beneficiary's primary address.


 
country_ID
string or null  <= 8 characters 
Identifier of the country of the Beneficiary's primary address.


 
date_Of_Birth
string or null <date-time> 
Date of birth of the Beneficiary.


 
end_Date
string or null <date-time> 
End date of the Beneficiary's status.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
exclude_Interest
required
boolean
Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
first_Name
string or null  <= 25 characters 
First name of the Beneficiary.


 
last_Name
string or null  <= 25 characters 
Last name of the Beneficiary.


 
long_Name
string or null  <= 512 characters 
Full name of the Beneficiary.


 
middle_Name
string or null  <= 25 characters 
Middle name of the Beneficiary.


 
percentage
number or null <double> 
Percentage of the benefit that is allotted to the associated Beneficiary.


 
primary_Beneficiary
boolean or null
Indicates whether the associated Beneficiary is the primary Beneficiary.


 
relationship
string or null  <= 12 characters 
Relationship of the Beneficiary to the Member.


 
ssn
string or null  <= 32 characters 
Social security number of the Beneficiary.


 
secondary_Beneficiary
boolean or null
This flag indicates if this beneficiary is secondary.


 
start_Date
string or null <date-time> 
Start date of the Beneficiary's status.


 
state
string or null  <= 2 characters 
State of the Beneficiary's primary address.


 
tertiary_Beneficiary
boolean or null
This flag indicates if this tertiary is secondary.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
zip
string or null  <= 32 characters 
Zip code of the Beneficiary's primary address.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "beneficiary_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "assignment": 0.1,
  • "city": "string",
  • "country_ID": "string",
  • "date_Of_Birth": "2019-08-24T14:15:22Z",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exclude_Interest": true,
  • "first_Name": "string",
  • "last_Name": "string",
  • "long_Name": "string",
  • "middle_Name": "string",
  • "percentage": 0.1,
  • "primary_Beneficiary": true,
  • "relationship": "string",
  • "ssn": "string",
  • "secondary_Beneficiary": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "state": "st",
  • "tertiary_Beneficiary": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberBeneficiary
Deletes an MemberBeneficiary


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
beneficiaryID
required
string
Beneficiary ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}
Request samples 
Create or Update Batch MemberBeneficiary
Create or Update multiple MemberBeneficiary at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
beneficiary_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier for this beneficiary on this member.


 
address
string or null  <= 512 characters 
Primary address of the Beneficiary.


 
address2
string or null  <= 128 characters 
Address line 2 of the Beneficiary's primary address.


 
assignment
number or null <double> 
A set amount paid to a beneficiary.


 
city
string or null  <= 32 characters 
City of the Beneficiary's primary address.


 
country_ID
string or null  <= 8 characters 
Identifier of the country of the Beneficiary's primary address.


 
date_Of_Birth
string or null <date-time> 
Date of birth of the Beneficiary.


 
end_Date
string or null <date-time> 
End date of the Beneficiary's status.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
exclude_Interest
required
boolean
Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
first_Name
string or null  <= 25 characters 
First name of the Beneficiary.


 
last_Name
string or null  <= 25 characters 
Last name of the Beneficiary.


 
long_Name
string or null  <= 512 characters 
Full name of the Beneficiary.


 
middle_Name
string or null  <= 25 characters 
Middle name of the Beneficiary.


 
percentage
number or null <double> 
Percentage of the benefit that is allotted to the associated Beneficiary.


 
primary_Beneficiary
boolean or null
Indicates whether the associated Beneficiary is the primary Beneficiary.


 
relationship
string or null  <= 12 characters 
Relationship of the Beneficiary to the Member.


 
ssn
string or null  <= 32 characters 
Social security number of the Beneficiary.


 
secondary_Beneficiary
boolean or null
This flag indicates if this beneficiary is secondary.


 
start_Date
string or null <date-time> 
Start date of the Beneficiary's status.


 
state
string or null  <= 2 characters 
State of the Beneficiary's primary address.


 
tertiary_Beneficiary
boolean or null
This flag indicates if this tertiary is secondary.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
zip
string or null  <= 32 characters 
Zip code of the Beneficiary's primary address.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}