Subscribers

Change Subscriber ID Advanced API

Changes a Subscriber ID globally

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
user_ID
required
string [ 1 .. 20 ] characters

The user for which this request is executed on behalf of.

current_Subscriber_ID
required
string [ 1 .. 9 ] characters

The current Subscriber_ID that will be changed.

new_Subscriber_ID
required
string [ 1 .. 9 ] characters

The new Subscriber_ID

Responses
202

Accepted for processing

401

Unauthorized

post/subscribers/{subscriberID}/change-id
Request samples
{
  • "user_ID": "string",
  • "current_Subscriber_ID": "string",
  • "new_Subscriber_ID": "string"
}

Member Disenroll Advanced API

Disenrolls a Member from an Enrollment. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.

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
user_ID
required
string [ 1 .. 20 ] characters

The user for which this request is executed on behalf of.

subscriber_ID
required
string [ 1 .. 9 ] characters

The Subscirber ID of the Member being disenrolled. You can get the Subscriber ID via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).

member_Seq
required
string [ 1 .. 2 ] characters

The Member Sequence of the Member being disenrolled. If this is a Subscriber Disenroll, the Member Sequence provided is the Insured Member Sequence. You can get the Member Seq via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).

group_ID
required
string [ 1 .. 20 ] characters

The Group ID of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.

division_ID
required
string [ 1 .. 20 ] characters

The Division ID of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.

group_Coverage_Start
required
string <date-time>

The Group Coverage Start of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.

start_Date
required
string <date-time>

The Start Date of the current Subenrollment record (the members current or most recent enrollment). You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.

disenroll_Date
required
string <date-time>

The Disenroll Date for this disenroll process.

term_Date
string or null <date-time>

Term Date is an informational field used in some reports. It doesn't impact the process but is often populated with the same value as the Disenroll Date.

subscriber
required
boolean

The Subscriber value is a flag indicating if the member being disenrolled is the Insured. Send 1 if this is the Subscriber, send 0 if this is a Spouse/Dependent/Other. This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.

reason_ID
required
integer <int32>

Reason ID is the reson for this disenroll. You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons).

premium
number or null <double>

When not using the PremRates list of PremRate_Key values, this indicates the COBRA Premium for some reports.

disenrollFamily
required
integer <int32>

The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options).

terminateAuth
required
boolean

The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.

disenrollFuture
required
integer <int32>

The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments

premRates
Array of integers or null <int32>

The list of COBRA Rates associated with this Disenroll process.

Array of objects or null (PremInvoiceAdjustment)

If you intend to auto-adjust existing premiums based on this disenroll you would populate your adjustments here.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/disenroll
Request samples
{
  • "user_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "subscriber": true,
  • "reason_ID": 0,
  • "premium": 0.1,
  • "disenrollFamily": 0,
  • "terminateAuth": true,
  • "disenrollFuture": 0,
  • "premRates": [
    ],
  • "premInvoiceAdjustments": [
    ]
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Billing Adjustments for Disenroll Advanced API

List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

asOfDate
required
string <date-time>

As of Date

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/as-of-date/{asOfDate}/disenroll-adjustments
Request samples 
Response samples 
No sample
List Waiting Period Details Advanced API 
List of Waiting Period configuration based on the passed in settings (group, division, plan, and/or hire date).


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupID
string
Group ID


 
divisionID
string
Division ID


 
planID
string
Plan ID


 
hireDate
string <date-time> 
Hire Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/enrollment-waiting-period-by-hire-date
Request samples 
Response samples 
No sample
Member Re-enroll Advanced API 
Re-enrolls a Member to an Enrollment.  A VBAProcess object is returned representing the process state. See VBAProcess area for more information.


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
user_ID
required
string  [ 1 .. 20 ] characters 
The user for which this request is executed on behalf of.


 
subscriber_ID
string or null
 
member_Seq
string or null
 
group_ID
string or null
 
division_ID
string or null
 
reenrollFamily
integer or null <int32> 
 
subscriber
boolean
 
start_Date
string or null <date-time> 
 
reenrollCOBRA
boolean
 
resetAuth
boolean
 
disenroll_Date
string or null <date-time> 
 
cobraDivision
string or null
 
cobraCovStart
string or null <date-time> 
 
cobraStart
string or null <date-time> 
 
cobraEnd
string or null <date-time> 
 
cobraReason
integer or null <int32> 
 
generateInvoice
boolean
 
invoiceDate
string or null <date-time> 
 
groupReenroll
boolean
 
resetGroupDisenroll
boolean
 
reenrollAll
boolean
 
Array of objects or null (COBRAPlanCriteria) 
 
memberSeqCriterias
Array of strings or null
 
Responses 
200
Success


401
Unauthorized


post/subscribers/{subscriberID}/members/{memberSeq}/reenroll
Request samples 
{
  • "user_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "reenrollFamily": 0,
  • "subscriber": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "reenrollCOBRA": true,
  • "resetAuth": true,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "cobraDivision": "string",
  • "cobraCovStart": "2019-08-24T14:15:22Z",
  • "cobraStart": "2019-08-24T14:15:22Z",
  • "cobraEnd": "2019-08-24T14:15:22Z",
  • "cobraReason": 0,
  • "generateInvoice": true,
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "groupReenroll": true,
  • "resetGroupDisenroll": true,
  • "reenrollAll": true,
  • "cobraPlanCriterias": [
    ],
  • "memberSeqCriterias": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Subscriber Add Enrollment Advanced API 
Adds enrollments to an existing subscriber. Can add enrollment for the subscriber or subscriber + all members.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
requesting_User_ID
required
string  [ 1 .. 20 ] characters 
User ID of the person making this request.


 
addMembers
boolean
Flag indicating if members should be enrolled in addition to the subscriber.  If false, only subscriber is enrolled; If true, members + subscriber is enrolled.


 
object (SubEnrollment) 
 
Responses 
202
Accepted


401
Unauthorized


post/subscribers/{subscriberID}/add-enrollment
Request samples 
{
  • "requesting_User_ID": "string",
  • "addMembers": true,
  • "subEnrollment": {
    }
}
List Disenrollment Family Options
List of all Disenrollment Family Options


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/disenroll-family-options
Request samples 
Response samples 
No sample
List Reenrollment Family Options
List of all Reenrollment Family Options


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/reenroll-family-options
Request samples 
Response samples 
No sample
List Cobra Duration Types
List of all Cobra Duration Types


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cobra-duration-types
Request samples 
Response samples 
No sample
List Cobra Disenroll Reason Types
List of all Cobra Disenroll Reason Types


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cobra-disenroll-reason-types
Request samples 
Response samples 
No sample
List Subscriber Benefits
List of all Benefits for the given Subscriber ID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/benefits
Request samples 
Response samples 
No sample
Create Subscribers
Creates a new Subscribers


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
string or null  <= 9 characters 
Unique identifier for each family unit inside VBA. This value can be imported, assigned or randomly assigned by the system at time of record creation.


 
address
string or null  <= 128 characters 
Address of the Subscriber.


 
address2
string or null  <= 128 characters 
Address Line 2 of the Subscriber.


 
billing_Cycle_ID
string or null  <= 2 characters 
Assigns a default billing cycle to be used when the Group Division 'Inv. Level' is set to 'Subscriber'.


 
billing_Invoice_Create
integer or null <int32> 
Specifies the number of projected billing cycles to include per invoice generation.


 
city
string or null  <= 32 characters 
City of the Subscriber.


 
country_ID
string or null  <= 8 characters 
Country of the Subscriber.


 
county_Code
string or null  <= 8 characters 
County of the Subscriber.


 
date_Enrolled
string or null <date-time> 
Date when the Subscriber was first enrolled.


 
disenroll_Date
string or null <date-time> 
Date when the Subscriber was disenrolled.


 
email
string or null  <= 256 characters 
Email of the Subscriber.


 
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.


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


 
home_Country_Code
string or null  <= 8 characters 
Country Code for the home phone number of the Subscriber.


 
home_Phone
string or null  <= 20 characters 
Home phone number of the Subscriber.


 
issue_State
string or null  <= 2 characters 
For Life & Disability clients, this holds the issue state for processing taxes and reporting.


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


 
middle_Name
string or null  <= 25 characters 
Middle initial of the Subscriber.


 
name_Suffix
string or null  <= 16 characters 
Suffix or title associated with the Subscriber.


 
notes
string or null
No longer in use. Replaced by NotData, NoteSource and NoteReference tables.


 
other_Name
string or null  <= 96 characters 
Information only. Used for custom reporting or client integrations.


 
pay_Period
string or null  <= 2 characters 
Number of annual pay periods for the Subscriber. This field is informational only.


 
pay_To_Account
integer or null <int32> 
References the FundingAccount.Account_Key and indicates the account to pay when payment reference this subscriber.


 
pend_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.


 
pend_Flag
string or null  <= 1 characters 
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.


 
region_Code
string or null  <= 32 characters 
Region code of the Member's primary address.


 
salutation
string or null  <= 16 characters 
Used by CSR to indicate the proper salutation used when communicating with the Insured.


 
sponsor_ID
string or null  <= 9 characters 
This holds the Subscriber ID of the subscriber that sponsored this subscriber.


 
sponsor_Relate_Code
string or null  <= 8 characters 
This identifies the relationship between the sponor and this subscriber.


 
state
string or null  <= 2 characters 
State of the Subscriber.


 
status
string or null  <= 6 characters 
No longer in use.


 
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.


 
work_Country_Code
string or null  <= 8 characters 
Country Code for the work phone number of the Subscriber.


 
work_Phone
string or null  <= 20 characters 
Work phone number of the Subscriber.


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Subscriber.


 
Responses 
200
Success


401
Unauthorized


post/subscribers
Request samples 
{
  • "subscriber_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "billing_Cycle_ID": "st",
  • "billing_Invoice_Create": 0,
  • "city": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "date_Enrolled": "2019-08-24T14:15:22Z",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Name": "string",
  • "home_Country_Code": "string",
  • "home_Phone": "string",
  • "issue_State": "st",
  • "last_Name": "string",
  • "middle_Name": "string",
  • "name_Suffix": "string",
  • "notes": "string",
  • "other_Name": "string",
  • "pay_Period": "st",
  • "pay_To_Account": 0,
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "region_Code": "string",
  • "salutation": "string",
  • "sponsor_ID": "string",
  • "sponsor_Relate_Code": "string",
  • "state": "st",
  • "status": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "work_Country_Code": "string",
  • "work_Phone": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List Subscribers
Lists all Subscribers


SecurityapiKeyAuth and bearerAuth 
Request 
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
Request samples 
Response samples 
No sample
List Active Subscribers for a Groupd & Division
Lists all Subscribers for the given Group & Division. If division is omitted, all divisions will be included.  Active is defined by a plan start date <= today and plan end date >= today.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupId
required
string
Group ID


 
divisionId
string
Division ID


 
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/active-subscribers
Request samples 
Response samples 
No sample
Get Subscribers
Gets Subscribers


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}
Request samples 
Response samples 
No sample
Update Subscribers
Updates a specific Subscribers.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
string or null  <= 9 characters 
Unique identifier for each family unit inside VBA. This value can be imported, assigned or randomly assigned by the system at time of record creation.


 
address
string or null  <= 128 characters 
Address of the Subscriber.


 
address2
string or null  <= 128 characters 
Address Line 2 of the Subscriber.


 
billing_Cycle_ID
string or null  <= 2 characters 
Assigns a default billing cycle to be used when the Group Division 'Inv. Level' is set to 'Subscriber'.


 
billing_Invoice_Create
integer or null <int32> 
Specifies the number of projected billing cycles to include per invoice generation.


 
city
string or null  <= 32 characters 
City of the Subscriber.


 
country_ID
string or null  <= 8 characters 
Country of the Subscriber.


 
county_Code
string or null  <= 8 characters 
County of the Subscriber.


 
date_Enrolled
string or null <date-time> 
Date when the Subscriber was first enrolled.


 
disenroll_Date
string or null <date-time> 
Date when the Subscriber was disenrolled.


 
email
string or null  <= 256 characters 
Email of the Subscriber.


 
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.


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


 
home_Country_Code
string or null  <= 8 characters 
Country Code for the home phone number of the Subscriber.


 
home_Phone
string or null  <= 20 characters 
Home phone number of the Subscriber.


 
issue_State
string or null  <= 2 characters 
For Life & Disability clients, this holds the issue state for processing taxes and reporting.


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


 
middle_Name
string or null  <= 25 characters 
Middle initial of the Subscriber.


 
name_Suffix
string or null  <= 16 characters 
Suffix or title associated with the Subscriber.


 
notes
string or null
No longer in use. Replaced by NotData, NoteSource and NoteReference tables.


 
other_Name
string or null  <= 96 characters 
Information only. Used for custom reporting or client integrations.


 
pay_Period
string or null  <= 2 characters 
Number of annual pay periods for the Subscriber. This field is informational only.


 
pay_To_Account
integer or null <int32> 
References the FundingAccount.Account_Key and indicates the account to pay when payment reference this subscriber.


 
pend_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.


 
pend_Flag
string or null  <= 1 characters 
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.


 
region_Code
string or null  <= 32 characters 
Region code of the Member's primary address.


 
salutation
string or null  <= 16 characters 
Used by CSR to indicate the proper salutation used when communicating with the Insured.


 
sponsor_ID
string or null  <= 9 characters 
This holds the Subscriber ID of the subscriber that sponsored this subscriber.


 
sponsor_Relate_Code
string or null  <= 8 characters 
This identifies the relationship between the sponor and this subscriber.


 
state
string or null  <= 2 characters 
State of the Subscriber.


 
status
string or null  <= 6 characters 
No longer in use.


 
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.


 
work_Country_Code
string or null  <= 8 characters 
Country Code for the work phone number of the Subscriber.


 
work_Phone
string or null  <= 20 characters 
Work phone number of the Subscriber.


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Subscriber.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}
Request samples 
{
  • "subscriber_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "billing_Cycle_ID": "st",
  • "billing_Invoice_Create": 0,
  • "city": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "date_Enrolled": "2019-08-24T14:15:22Z",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "first_Name": "string",
  • "home_Country_Code": "string",
  • "home_Phone": "string",
  • "issue_State": "st",
  • "last_Name": "string",
  • "middle_Name": "string",
  • "name_Suffix": "string",
  • "notes": "string",
  • "other_Name": "string",
  • "pay_Period": "st",
  • "pay_To_Account": 0,
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "region_Code": "string",
  • "salutation": "string",
  • "sponsor_ID": "string",
  • "sponsor_Relate_Code": "string",
  • "state": "st",
  • "status": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "work_Country_Code": "string",
  • "work_Phone": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Subscribers
Deletes an Subscribers


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
string or null  <= 9 characters 
Unique identifier for each family unit inside VBA. This value can be imported, assigned or randomly assigned by the system at time of record creation.


 
address
string or null  <= 128 characters 
Address of the Subscriber.


 
address2
string or null  <= 128 characters 
Address Line 2 of the Subscriber.


 
billing_Cycle_ID
string or null  <= 2 characters 
Assigns a default billing cycle to be used when the Group Division 'Inv. Level' is set to 'Subscriber'.


 
billing_Invoice_Create
integer or null <int32> 
Specifies the number of projected billing cycles to include per invoice generation.


 
city
string or null  <= 32 characters 
City of the Subscriber.


 
country_ID
string or null  <= 8 characters 
Country of the Subscriber.


 
county_Code
string or null  <= 8 characters 
County of the Subscriber.


 
date_Enrolled
string or null <date-time> 
Date when the Subscriber was first enrolled.


 
disenroll_Date
string or null <date-time> 
Date when the Subscriber was disenrolled.


 
email
string or null  <= 256 characters 
Email of the Subscriber.


 
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.


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


 
home_Country_Code
string or null  <= 8 characters 
Country Code for the home phone number of the Subscriber.


 
home_Phone
string or null  <= 20 characters 
Home phone number of the Subscriber.


 
issue_State
string or null  <= 2 characters 
For Life & Disability clients, this holds the issue state for processing taxes and reporting.


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


 
middle_Name
string or null  <= 25 characters 
Middle initial of the Subscriber.


 
name_Suffix
string or null  <= 16 characters 
Suffix or title associated with the Subscriber.


 
notes
string or null
No longer in use. Replaced by NotData, NoteSource and NoteReference tables.


 
other_Name
string or null  <= 96 characters 
Information only. Used for custom reporting or client integrations.


 
pay_Period
string or null  <= 2 characters 
Number of annual pay periods for the Subscriber. This field is informational only.


 
pay_To_Account
integer or null <int32> 
References the FundingAccount.Account_Key and indicates the account to pay when payment reference this subscriber.


 
pend_Ex_Code
string or null  <= 6 characters 
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.


 
pend_Flag
string or null  <= 1 characters 
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.


 
region_Code
string or null  <= 32 characters 
Region code of the Member's primary address.


 
salutation
string or null  <= 16 characters 
Used by CSR to indicate the proper salutation used when communicating with the Insured.


 
sponsor_ID
string or null  <= 9 characters 
This holds the Subscriber ID of the subscriber that sponsored this subscriber.


 
sponsor_Relate_Code
string or null  <= 8 characters 
This identifies the relationship between the sponor and this subscriber.


 
state
string or null  <= 2 characters 
State of the Subscriber.


 
status
string or null  <= 6 characters 
No longer in use.


 
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.


 
work_Country_Code
string or null  <= 8 characters 
Country Code for the work phone number of the Subscriber.


 
work_Phone
string or null  <= 20 characters 
Work phone number of the Subscriber.


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Subscriber.


 
Responses 
207
Success


401
Unauthorized


put/subscribers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get Unique Subscriber ID
Get a unique Subscriber ID you can use for creating a new Subscriber or changing an existing Subscirbers ID


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers-generate-id
Request samples 
Response samples 
No sample