# List MemberBeneficiary

Lists all MemberBeneficiary for the given subscriberID and memberSeq

Endpoint: GET /subscribers/{subscriberID}/members/{memberSeq}/beneficiaries
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `subscriberID` (string, required)
    Subscriber ID

  - `memberSeq` (string, required)
    Member Seq

## Query parameters:

  - `page` (integer)
    Page

  - `pageSize` (integer)
    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.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.subscriber_ID` (string, required)
    References Members.Subscriber_ID value on the parent record.

  - `data.member_Seq` (string, required)
    References Members.Member_Seq value on the parent record.

  - `data.beneficiary_ID` (string,null)
    Unique identifier for this beneficiary on this member.

  - `data.address` (string,null)
    Primary address of the Beneficiary.

  - `data.address2` (string,null)
    Address line 2 of the Beneficiary's primary address.

  - `data.assignment` (number,null)
    A set amount paid to a beneficiary.

  - `data.city` (string,null)
    City of the Beneficiary's primary address.

  - `data.country_ID` (string,null)
    Identifier of the country of the Beneficiary's primary address.

  - `data.date_Of_Birth` (string,null)
    Date of birth of the Beneficiary.

  - `data.end_Date` (string,null)
    End date of the Beneficiary's status.

  - `data.entry_Date` (string)
    Date when the record was first added to the system.

  - `data.entry_User` (string,null)
    User that first added the record to the system.

  - `data.exclude_Interest` (boolean, required)
    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.

  - `data.first_Name` (string,null)
    First name of the Beneficiary.

  - `data.last_Name` (string,null)
    Last name of the Beneficiary.

  - `data.long_Name` (string,null)
    Full name of the Beneficiary.

  - `data.middle_Name` (string,null)
    Middle name of the Beneficiary.

  - `data.percentage` (number,null)
    Percentage of the benefit that is allotted to the associated Beneficiary.

  - `data.primary_Beneficiary` (boolean,null)
    Indicates whether the associated Beneficiary is the primary Beneficiary.

  - `data.relationship` (string,null)
    Relationship of the Beneficiary to the Member.

  - `data.ssn` (string,null)
    Social security number of the Beneficiary.

  - `data.secondary_Beneficiary` (boolean,null)
    This flag indicates if this beneficiary is secondary.

  - `data.start_Date` (string,null)
    Start date of the Beneficiary's status.

  - `data.state` (string,null)
    State of the Beneficiary's primary address.

  - `data.tertiary_Beneficiary` (boolean,null)
    This flag indicates if this tertiary is secondary.

  - `data.update_Date` (string)
    Date when the record was last updated in the system.

  - `data.update_User` (string,null)
    User that last updated the record in the system.

  - `data.zip` (string,null)
    Zip code of the Beneficiary's primary address.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields