Adv. Enrollment

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": {
    }
}
Subscriber Policy Surrender Advanced API 
Surrender an existing Policy under the Policy & Forfeiture area.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
cashValue
required
number <double> 
Cash Value


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted


401
Unauthorized


post/subscribers/{subscriberID}/surrender-policy/{planID}/{benefitCode}/{policyNumber}/{cashValue}
Request samples 
Subscriber Division Transfer Advanced API 
Transfer a Subscriber Enrollment from one Division to another.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
currentEnrollEndDate
required
string <date-time> 
Current Enrollment End Date


 
newEnrollStartDate
required
string <date-time> 
New Enrollment Start Date


 
newEnrollDivisionID
required
string
New Enrollment DivisionID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted


401
Unauthorized


post/subscribers/{subscriberID}/division-transfer/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/{currentEnrollEndDate}/{newEnrollStartDate}/{newEnrollDivisionID}
Request samples 
Recalculate Subscriber Accumulators Advanced API 
Recalculate Accumulators for a given Subscriber ID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


post/subscribers/{subscriberID}/recalculate-accumulators
Request samples 
Recalculate Member Teeth Advanced API 
Recalculate All Teeth for a given Subscriber and Member.  Pass the requestingUserId if this request is being made on behalf of another User.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
query Parameters
requestingUserId
string
Requesting User


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


post/subscribers/{subscriberID}/members/{memberSeq}/recalculate-teeth
Request samples