API Reference
Start typing to search…

GET RESP Beneficiary Details

get https://example.com/investment/web/Investments///Beneficiary//Details

Retrieve investment RESP beneficiary details by Company, InstrumentNumber and 'Client Number'. This only applies to RESP plans. Not currently implemented

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The GET /System/Companies endpoint from the System Admin specification can be used to find an available value for this path parameter.

integer
required

The account number identifying the investment plan.

integer
required

The Portfolio+ client number of the educational beneficiary to request details for.

Responses

Response body
object
data
object
string

Company code of company associated with the plan type.

number

Unique identifer of the investment plan.

number

Unique identifier of the beneficiary.

number

Unique identifier of the parent of the beneficiary.

boolean

Indicates if the beneficiary is EAP eligible.

boolean

Indicates if the beneficiary is CESG eligible.

boolean

Indicates if the beneficiary has applied for CESG.

string

Relation to subscriber.

date

Date the beneficiary is tainted until.

boolean

Indicates if the beneficiary is CESG eligible.

date

SAGES Application Date.

boolean

Indicates if the beneficiary is BCTESG eligible.

date

BCTESG Application Date.

date

On file date Date.

date

Replaced Date.

boolean

Family replacement.

string

Contract Number.

string

Specimen Number.

boolean

Is the beneficiary impaired.

string

The available values for this can be retrieved from the GET /System/Investments/EducationalInstitutions endpoint.

string

The available values for this can be retrieved from the GET /System/Investments/EducationalPrograms endpoint.

string

The available values for this can be retrieved from the GET /System/Investments/AcademicCodes endpoint.

integer

The current year of program the beneficiary is attending.

BeneficiaryLinkArray
array of objects

An array of links to enable fetching the client profile record for the associated related client. This will include a link to the beneficiary client profile as well as the parent client profile.

BeneficiaryLinkArray
object
string

Describes how this link is related to the resource within which it is embedded

url

URL which can be used to retrieve the resource described by RelationType

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

500

An error occurred on the backend server

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
Authenticate

Updated about 2 months ago

Did this page help you?