Personal Plan(s)
This action retrieves information about personal plan(s). It's essential to note that all personal plans are intrinsically associated with a plan request.
Every piece of information returned in this action is also readily available via the personal plan page.
API Method:
Fetch Personal Plan(s)
POST
https://app.whiteswan.io/api/1.1/wf/personal_plan
Returns information about personal plans associated with your White Swan account.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer <YOUR API KEY> |
Content-Type* | String | application/json |
Accept* | String | application/json |
user-agent* | String | <YOUR APP> |
Request Body
Name | Type | Description |
---|---|---|
JSON Body* | Object | See specification below |
Please note that the sample body payload above contains all possible parameters for your reference. In an actual call, you don't need to use all (or any) parameters.
Code Examples - Making the API Call:
Code examples are available in cURL, Python, Javascript, Java, PHP, Ruby, and Go, but can be constructed for other languages and tools. Some code examples include dependencies that may need to be installed in your codebase to ensure functionality. Remember to replace any values in the code that looks like <VALUE> and to adapt the parameter values passed.
Body Parameters Specification:
Field Label | Field Key | Field Type | Example Value | Description |
---|---|---|---|---|
Personal Plan ID (Optional) | plan_id | Text | 8052128065x89026589 | To retrieve information about a specific personal plan, you can map a personal plan ID from another trigger/action here. |
Account User Email (Optional) | user_email | Text | john@doe.com | Can optionally be used to only show personal plans that are associated with a particular user in your account. |
Client Email (Optional) | client_email | Text | jane@gmail.com | Can optionally be used to show personal plans associated with a particular client referred through your account. |
Returned Parameters Specification:
Field Label | Field Key | Field Type | Example Value | Description |
---|---|---|---|---|
Personal Plan URL | personal_plan_url | Text | https://app.whiteswan.io/personal_plan/john-doe | Direct link to view the personal plan. |
Client Name | client_name | Text | John Doe | Full name of the client. |
Client Email | client_email | Text | john@doe.com | Email address of the client. |
Client Phone | client_phone | Text | 1234567890 | Phone number of the client. |
Intended Owner | intended_owner | Text | Acme Inc | Entity or individual intended to be the owner of the plan. |
Intended Insured | intended_insured | Text | John Doe | Entity or individual intended to be insured by the plan. |
Expiration Date | expiration_date | DateTime | 2023-05-25T18:19:44.611Z | Date and time when the plan will expire. |
Plan Success Manager | plan_success_manager | Text | Eric Mikolai | Name of the success manager associated with the plan. |
Plan Success Manager Email | plan_success_manager_email | Text | eric@whiteswan.io | Email address of the success manager. |
Plan Success Manager Phone | plan_success_manager_phone | Text | 1234567890 | Phone number of the success manager. |
Plan Success Manager Meeting Link | plan_success_manager_meeting_link | Text | https://calendly.com/eric_whiteswan/personal-plan-review | A link to book a meeting with the client success manager. |
Personal Message | personal_message | Text | Hi John! By comparing several options... | Personalized message from the success manager to the client. |
Applied For | applied_for | Boolean | False | Indicates whether the plan has been applied for. |
Insurer Name | insurer_name | Text | John Hancock | Name of the insurance company providing the plan. |
Insurer Logo | insurer_logo | Text | https://s3.amazonaws.com/appforest_uf/f1660780457493x297075060123930300/john%20hancock%20Logo.png | A logo image file of the insurer associated with this plan. |
Product Name | product_name | Text | Sample Policy | Name of the insurance product. |
Insurance Illustration PDF | illustration_pdf | Text | https://s3.amazonaws.com/appforest_uf/f1681150722309x32924951370300/john-doe-illustration.pdf | A link to the insurance illustration PDF provided by the insurer associated with this plan. |
Prospectus PDF | prospectus_pdf | Text | https:https://s3.amazonaws.com/appforest_uf/f1681150732287801017500398200/john-doe-prospectus.pdf | For variable universal life, a link to the prospectus PDF provided by the insurer associated with this plan. |
Term Life Length (Text) | term_length | Text | 10 Years | For term life, the length of the coverage in text. |
Term Life Length (Number) | term_length_numerical | Number | 10 | For term life, the length of the coverage in numbers. |
Assumed Annual Return (Variable Universal Life) | assumed_annual_return | Number | 0.08 | For variable universal life, the assumed annual return of the plan. |
Initial Death Benefit | initial_death_benefit | Number | 1000000 | The initial death benefit of this plan. |
Payment Schedule | premium_modality | Text | Monthly | The payment schedule for this plan. |
Recurring Premium Amount | recurring_premium | Number | 258 | The amount of premium planned per premium installment for this plan. |
One Time Deposit | one_time_deposit | Number | 1000 | The one time deposit amount for this plan. |
Policy Type | policy_type | Text | Variable Universal Life | Type of insurance policy. |
Main Goal | main_goal | Text | Accumulation | Primary objective of the insurance policy. |
Health Rating | health_rating | Text | Preferred Plus | Assumed health rating for the plan. |
Annual Retirement Income | annual_retirement_income | Number | 100000 | Expected annual retirement income from the plan. |
Total Retirement Income | total_retirement_income | Number | 3000000 | Total expected retirement income from the plan. |
Years of Retirement Income | years_of_retirement_income | Number | 20 | Duration (in years) of the retirement income. |
Annual Target Premium | annual_target_premium | Number | 4500 | The annual target premium for the plan. |
Annual Total Premium | annual_total_premium | Number | 6000 | Total annual premium for the plan. |
Paid Up Period | paid_up_period | Text | 30 Years | Duration (in text) after which no further premiums are required. |
Paid Up Period Numerical | paid_up_period_numerical | Number | 30 | Duration (in numbers) after which no further premiums are required. |
Projected Cash Values | projected_cash_values | Object List | - | The projected future cash values for the plan. |
-Insured Age | insured_age | Number | 15 | Age of the insured when the projected cash value is calculated. |
-Projected Cash Value | cash_value | Number | 10000 | Projected cash values at future insured ages. |
Projected Death Benefits | projected_death_benefits | Object List | - | The projected future death benefits for the plan. |
-Insured Age | insured_age | Number | 85 | Age of the insured when the projected death benefit is calculated. |
-Projected Death Benefit | death_benefit | Number | 150000 | Projected death benefits at future insured ages. |
Projected Cash Value Internal Rates of Return | future_cash_values_irr | Object List | - | The projected future internal rates of return for the cash value of this plan. |
-Insured Age | insured_age | Number | 65 | The future age of the insured person when the IRR is calculated. |
-Projected Cash Value Internal Rate of Return | irr_rate | Number | 0.07 | The internal rate of return at the future age. |
Projected Death Benefit Internal Rates of Return | future_death_benefits_irr | Object List | - | The projected future internal rates of return for the death benefit of this plan. |
-Insured Age | insured_age | Number | 85 | The future age of the insured person when the IRR is calculated. |
-Projected Death Benefit Internal Rate of Return | irr_rate | Number | 0.07 | The internal rate of return at the future age. |
Riders Included in Plan | riders | Line Item(s) | - | The riders included in the plan. |
-Rider Name | name | Text | Guaranteed Insurability Rider | Name of the rider. |
-Rider Description | description | Text | Allows you to get additional life insurance policies... | Description of the rider. |
Allocation Accounts/Funds | allocation_accounts | Line Item(s) | - | For Variable/Indexed Universal Life, the accounts to which the cash value is planned to be initially allocated to. |
-Allocation Account/Fund Name | name | Text | Sample Fund | Name of the fund or account where allocations are made. |
-Percentage Allocation | allocation_percentage | Number | 0.75 | Percentage of allocation to a fund or account. |
-Fund Inception Year | fund_inception | Number | 2000 | Year when a fund was started. |
-Fund Average Historical Return | average_historical_return | Number | 0.089 | Average return of a fund. |
-Fund Min Historical Return | min_historical_return | Number | -0.09 | The lowest historical annual return of a fund. |
-Fund Max Historical Return | max_historical_return | Number | 0.5 | The highest historical annual return of a fund. |
-Fund Managing Institution | managing_institution | Text | Sample Asset Manager | Institution managing a fund. |
-Fund Account Fee | fund_account_fee | Number | 0.005 | The annual fee of a fund. |
-Fund Morningstar Rating | morningstar_rating | Number | 9 | The morningstar rating of a fund (0-10) |
-Fixed Account Current Rate | fixed_current_interest | Number | 0.03 | The current interest rate of a fixed account. |
-Fixed Account Guaranteed Minimum Rate | fixed_guaranteed_interest | Number | 0.01 | The guaranteed minimum interest rate of a fixed account. |
-Indexed Account Floor Rate | indexed_floor_rate | Number | 0 | The floor rate of an indexed account. |
-Indexed Account Cap Rate | indexed_cap_rate | Number | 0.1 | The cap rate of an indexed account. |
-Indexed Account Participation Rate | indexed_participation_rate | Number | 1 | The participation rate of an indexed account. |
-Indexed Account Bonus/Multiplier | indexed_bonus_multiplier | Text | None | The bonus/multiplier of an indexed account. |
-Indexed Account Underlying Index | underlying_index | Text | S&P 500 Price Index | The underlying index of an indexed account. |
Personal Plan ID | plan_id | Text | 1681150784604x148984488584282100 | Unique identifier for the personal plan. |
Associated Request ID | associated_request_id | Text | 1681142208501x817915131724300300 | ID of the request associated with the plan. |
Last updated