Human Interest
App · 12 actions
Read retirement plan details, participants, contribution rates and investment elections.
Actions
| Action | What it does |
|---|---|
| Get beneficiaries | Get beneficiaries. |
| Get contribution rate | Get contribution rate. |
| Get investment election | Get investment election. |
| Get investment questionnaire | Get investment questionnaire. |
| Get participant | Get participant. |
| Get participant status | Get participant status. |
| Get partner client | Get partner client. |
| Get plan | Get plan. |
| Get plan employers | Get plan employers. |
| List participants | List participants. |
| List partner clients | List partner clients. |
| List plan admins | List plan admins. |
Get beneficiaries
Get beneficiaries. Returns null when the record is unavailable to your account.
Inputs
- Participant id
participant_idtextRequired - Participant id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participant": {
"beneficiariesSet": false,
"beneficiaryDesignations": [],
"id": "example"
}
}
}Get contribution rate
Get contribution rate. Returns null when the record is unavailable to your account.
Inputs
- Participant id
participant_idtextRequired - Participant id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participant": {
"contributionRate": {
"desiredPostTaxRate": 1.0,
"desiredPreTaxRate": 1.0,
"desiredRateType": "example",
"effectiveDate": "example",
"effectivePostTaxRate": 1.0,
"effectivePreTaxRate": 1.0,
"effectiveRateType": "example",
"mode": "example",
"throttleReason": "example"
},
"enrollmentStatus": "example",
"id": "example"
}
}
}Get investment election
Get investment election. Returns null when the record is unavailable to your account.
Inputs
- Participant id
participant_idtextRequired - Participant id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participantInvestmentElection": {
"allocations": [],
"electionType": "example",
"model": {
"id": "example",
"name": "example",
"riskScore": 1.0
},
"status": "example"
}
}
}Get investment questionnaire
Get investment questionnaire. Returns null when the record is unavailable to your account.
Inputs
None.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participantInvestmentQuestionnaire": {
"questions": []
}
}
}Get participant
Get participant. Returns null when the record is unavailable to your account.
Inputs
- Participant id
participant_idtextRequired - Participant id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participant": {
"human": {
"birthDate": "example",
"firstName": "example",
"lastName": "example",
"maritalStatus": "example"
},
"id": "example",
"planId": "example"
}
}
}Get participant status
Get participant status. Returns null when the record is unavailable to your account.
Inputs
- Participant id
participant_idtextRequired - Participant id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participant": {
"deferralEligibilityStatus": "example",
"enrollmentStatus": "example",
"hasActiveEmployment": false,
"id": "example",
"matchEligibilityStatus": "example"
}
}
}Get partner client
Get partner client. Returns null when the record is unavailable to your account.
Inputs
- Partner client id
partner_client_idtextRequired - Partner client id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"partnerClient": {
"id": "example",
"plan": {
"id": "example",
"name": "example",
"type": "example"
},
"status": "example"
}
}
}Get plan
Get plan. Returns null when the record is unavailable to your account.
Inputs
- Plan
plan_idtextRequired - Plan id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"plan": {
"id": "example",
"name": "example",
"type": "example"
}
}
}Get plan employers
Get plan employers. Returns null when the record is unavailable to your account.
Inputs
- Plan
plan_idtextRequired - Plan id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"plan": {
"id": "example",
"primaryEmployer": {
"divisions": [],
"id": "example",
"legalName": "example"
}
}
}
}List participants
List participants. Returns null when the record is unavailable to your account.
Inputs
- Plan
plan_idtextRequired - Plan id.
- First
firstnumber - First.From 1 to 200.
- After
aftertext - After.
Outputs
dataobject- Service response.
Example output
{
"data": {
"participants": {
"edges": [],
"pageInfo": {
"endCursor": "example",
"hasNextPage": false
},
"totalCount": 1
}
}
}List partner clients
List partner clients. Returns null when the record is unavailable to your account.
Inputs
- Partner account id
partner_account_idtext - Leave empty to use your connected partner account.
- First
firstnumber - First.From 1 to 100.
- After
aftertext - After.
Outputs
dataobject- Service response.
Example output
{
"data": {
"partnerClients": {
"edges": [],
"pageInfo": {
"endCursor": "example",
"hasNextPage": false
},
"totalCount": 1
}
}
}List plan admins
List plan admins. Returns null when the record is unavailable to your account.
Inputs
- Plan
plan_idtextRequired - Plan id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"plan": {
"customerAccount": {
"admins": []
}
}
}
}