APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
References Members.Subscriber_ID value on the parent record.
References Members.Member_Seq value on the parent record.
Identifier of the country of the Beneficiary's primary address.
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.
Percentage of the benefit that is allotted to the associated Beneficiary.
Indicates whether the associated Beneficiary is the primary Beneficiary.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries' \
-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",
"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"
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries
- 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}/beneficiaries?page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/beneficiaries/{beneficiaryID}
- 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}/beneficiaries/{beneficiaryID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example