APIs for VBASoftware
- List Members
List Plan Year by Member
Benefit Inquiry
Auto-Assign Primary Care Physician
List Members with Auto-Assign Primary Care Physician
List Providers that are eligible for PCP Auto-Assign
Create Members
Get Members
Update Members
Delete Members
Create or Update Batch Members
Get MembersDisabilityTaxSummary
Retrieves the member EOB (Explanation of Benefits) PDF for the specified batch claim.
List Members
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
References the Subscribers.Subscriber_ID value in the parent table.
Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.
Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.
This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'. Note: This field is marked as NOT NULL in the database and therefore required by the API.
End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.
Allows the User to assign an 'Alternate ID' to the Member.
Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.
Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).
End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.
Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.
This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.
Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: This field is marked as NOT NULL in the database and therefore required by the API.
An optional reminder that the Member has an 'Other Insurance'. [Informational Only] Note: This field is marked as NOT NULL in the database and therefore required by the API.
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.
Defines the number of months/years covered by the Member's plan.
Specifies the timeframe the Member Plan Year will use.
Identifies whether the Member has any pre-existing conditions.
End date of pre-existing conditions in relation to the Member's plan.
Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies that the Member meets the 'Student Status' requirements.
End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.
Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.
VIP status of the Member. This status can be used as a search filter but is otherwise informational only.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"subscriber_ID": "string",
"member_Seq": "st",
"access_Code": "string",
"adult_Child": "s",
"adult_Dependent": true,
"adult_Dependent_End": "2019-08-24T14:15:22Z",
"alternate_ID": "string",
"birth_Date": "2019-08-24T14:15:22Z",
"continue_Coverage": true,
"continue_Coverage_End_Date": "2019-08-24T14:15:22Z",
"continue_Coverage_Ex_Code": "string",
"coverage_Type": "string",
"credible_Coverage": 0,
"creditable_Coverage_End": "2019-08-24T14:15:22Z",
"creditable_Coverage_Start": "2019-08-24T14:15:22Z",
"date_Enrolled": "2019-08-24T14:15:22Z",
"date_Of_Death": "2019-08-24T14:15:22Z",
"disenroll_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ethnicity_Code": "s",
"first_Name": "string",
"height": 0,
"initial_Premium": 0.1,
"initial_Volume": 0.1,
"initial_Volume_Salary_Pct": true,
"last_Name": "string",
"marital_Status": "s",
"middle_Name": "string",
"name_Suffix": "string",
"notes": "string",
"other_Insurance": true,
"other_Name": "string",
"pend_Ex_Code": "string",
"pend_Flag": "s",
"plan_Year_Frequency": 0,
"plan_Year_Frequency_Type": "s",
"pre_Exist": "s",
"pre_Exist_End": "2019-08-24T14:15:22Z",
"pre_Exist_Ex_Code": "string",
"preferred_Pronoun": "string",
"relationship": "string",
"ssn": "string",
"salutation": "string",
"sex": "s",
"smoker": true,
"student": "s",
"student_End": "2019-08-24T14:15:22Z",
"unique_ID": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Member_Plan_Year": true,
"viP_Flag": "s",
"weight": 0
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members?page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response exampleBodyrequired
- application/json
- text/json
- application/*+json
References the Subscribers.Subscriber_ID value in the parent table.
Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.
Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.
This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'. Note: This field is marked as NOT NULL in the database and therefore required by the API.
End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.
Allows the User to assign an 'Alternate ID' to the Member.
Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.
Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).
End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.
Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.
This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.
Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: This field is marked as NOT NULL in the database and therefore required by the API.
An optional reminder that the Member has an 'Other Insurance'. [Informational Only] Note: This field is marked as NOT NULL in the database and therefore required by the API.
Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.
While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.
Defines the number of months/years covered by the Member's plan.
Specifies the timeframe the Member Plan Year will use.
Identifies whether the Member has any pre-existing conditions.
End date of pre-existing conditions in relation to the Member's plan.
Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Identifies that the Member meets the 'Student Status' requirements.
End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.
Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.
VIP status of the Member. This status can be used as a search filter but is otherwise informational only.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"subscriber_ID": "string",
"member_Seq": "st",
"access_Code": "string",
"adult_Child": "s",
"adult_Dependent": true,
"adult_Dependent_End": "2019-08-24T14:15:22Z",
"alternate_ID": "string",
"birth_Date": "2019-08-24T14:15:22Z",
"continue_Coverage": true,
"continue_Coverage_End_Date": "2019-08-24T14:15:22Z",
"continue_Coverage_Ex_Code": "string",
"coverage_Type": "string",
"credible_Coverage": 0,
"creditable_Coverage_End": "2019-08-24T14:15:22Z",
"creditable_Coverage_Start": "2019-08-24T14:15:22Z",
"date_Enrolled": "2019-08-24T14:15:22Z",
"date_Of_Death": "2019-08-24T14:15:22Z",
"disenroll_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"ethnicity_Code": "s",
"first_Name": "string",
"height": 0,
"initial_Premium": 0.1,
"initial_Volume": 0.1,
"initial_Volume_Salary_Pct": true,
"last_Name": "string",
"marital_Status": "s",
"middle_Name": "string",
"name_Suffix": "string",
"notes": "string",
"other_Insurance": true,
"other_Name": "string",
"pend_Ex_Code": "string",
"pend_Flag": "s",
"plan_Year_Frequency": 0,
"plan_Year_Frequency_Type": "s",
"pre_Exist": "s",
"pre_Exist_End": "2019-08-24T14:15:22Z",
"pre_Exist_Ex_Code": "string",
"preferred_Pronoun": "string",
"relationship": "string",
"ssn": "string",
"salutation": "string",
"sex": "s",
"smoker": true,
"student": "s",
"student_End": "2019-08-24T14:15:22Z",
"unique_ID": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"use_Member_Plan_Year": true,
"viP_Flag": "s",
"weight": 0
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members?page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
No response example