Start Personal Plan Request
This action can be used to start a new customized plan request for an end-user. It will return a URL which you can either link out to or embed in your website/app to allow the end-user or someone on your team to finish the request.
Any information provided in the input of this action will skip the corresponding question in the plan request. This action can also be used to standardize choices and package life insurance offerings for the end-user.
API Method:
Start Personal Plan Request
POST
https://app.whiteswan.io/api/1.1/wf/new_request
Starts a new personal plan request and returns a URL that can be embedded or linked out to.
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 parameters, and some parameters are only relevant for certain policy types of plan goals.
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. Please note that the code examples above does not contain all available input fields. Feel free to edit using the specification below. Also remember to replace any values in the code that looks like <VALUE> and to adapt the parameter values passed.
If the Policy Type and the Main Goal is provided with the request, the returned URL will go straight to the personal plan request, if not, the returned URL will go to the plan recommendation engine.
Body Parameters Specification:
Field Label | Field Key | Field Type | Required | Example Value | Description | Alternatives (if Multiple-Choice) |
---|---|---|---|---|---|---|
Name | name | Text | No | John Doe | The full name of the person who the request is made on behalf of. | - |
Text | No | john@example.com | The email of the person who the request is made on behalf of. | - | ||
Intended Insured Name | intended_insured_name | Text | No | Jack Doe | If the intended insured is not the same person as the policy holder, include the full name of the intended insured. | - |
Second Insured Name | name_2 | Text | No | Jane Doe | If covering two people, the full name of the second insured. | - |
Policy type | policy_type | Multiple-Choice | No | Term Life | The policy type that this request is made for. If this and the main goal is provided with the request, the returned URL will go straight to the personal plan request, if not, the returned URL will go to the plan recommendation engine. | Variable Universal Life, Indexed Universal Life, Whole Life, Term Life, Guaranteed Universal Life, Private Placement Life |
Main Goal | main_goal | Multiple-Choice | No | Accumulation | The primary goal of this plan request, either Protection, Balanced or Accumulation. If this and the policy type is provided with the request, the returned URL will go straight to the personal plan request, if not, the returned URL will go to the plan recommendation engine. | Accumulation, Balanced, Protection |
Embed URL | embed_url | Boolean | No | false | If Embed URL is true, this action will return a URL that can be embedded in the same way that normal pages can be embedded through White Swan. | - |
Turbo Request Mode (Skip Extras Section) | extras | Boolean | No | false | If this option is set as true, this request will skip the extras section, which contains deeper plan customization options such as retirement income planning, account selection, rider selection, and more. | - |
Pre-fill Application Data ID | contact_id | Text | No | 12345 | If you have already created a pre-fill information you can pass its ID by using this parameter to associate that info with this request. | - |
Custom Success Page (URL) | redirect_url | Text | No | https://example.com/success | If this is provided this request will be redirected to your custom URL when the request is finished, which you can use to nurture client relationships or cross sell other products/services. | - |
Case Associated Person (Email) | associated_person | Text | No | associate@example.com | Optionally this case can be associated with a specific user on your White Swan account by including their email here. If left blank, it will be the person who set up this zap. | - |
Phone Number | phone | Text | No | (123) 456-7890 | The phone number of the person who the request is made on behalf of. | - |
Resident State | resident_state | Multiple-Choice | No | California | The state in which the insured person is a resident. | All 50 States in the United States, written out in full in a capitalized form like example value. |
Death Benefit Need | death_benefit | Number | No | 500000 | The amount of death benefit that is required for this plan. To opt for the lowest amount possible given a certain premium budget, use 0. | - |
Payment Schedule | payment_schedule | Multiple-Choice | No | Monthly | How often premiums should be paid on this plan. | Monthly, Quarterly, Yearly |
Paid Up Period | paid_up_period | Multiple-Choice | No | 10 Years | How many years premiums should be paid on the policy (N/A for term life). | One-time, 10 Years, 20 Years, 30 Years, Lifetime |
Term Life Coverage Period | term_duration | Multiple-Choice | No | 20 Years | If this request is for term life, how many years the policy should cover the insured. | Less than 10 years, 10 Years, 15 Years, 20 Years, 30 Years, 40 Years |
Premium Budget | premium_budget | Number | No | 1000 | The budget for premium payments (only applicable for plan requests with Accumulation as the main goal). | - |
Gender | gender | Multiple-Choice | No | Male | Whether the intended insured person is Male or Female. | Male, Female |
Second Insured Gender | gender_2 | Multiple-Choice | No | Female | If covering two people, if the second insured is Male or Female. | Male, Female |
Date of Birth | date_of_birth | DateTime | No | 19850716T000000+0100 | The date of birth of the intended insured person. | - |
Second Insured Date of Birth | date_of_birth_2 | DateTime | No | 19850716T000000+0100 | If covering two people, the date of birth of the second insured. | - |
Health Rating | health_rating | Multiple-Choice | No | Good | How the insured person would rate their own general health. | Average, Good, Excellent |
Second Insured Health Rating | health_rating2 | Multiple-Choice | No | Excellent | If covering two people, how would the second insured rate their general health. | Average, Good, Excellent |
Insured Uses Tobacco/Nicotine | tobacco | Boolean | No | false | Whether the intended insured person uses tobacco/nicotine products or not. | - |
Second Insured Uses Tobacco/Nicotine | tobacco_2 | Boolean | No | false | If covering two people, whether the second insured uses tobacco/nicotine products or not. | - |
Insured Uses Marijuana/THC | marijuana | Boolean | No | false | Whether the intended insured person uses marijuana/THC products or not. | - |
Second Insured Uses Marijuana/THC | marijuana_2 | Boolean | No | false | If covering two people, whether the second insured uses marijuana/THC products or not. | - |
Insured Height in Feet | height_feet | Number | No | 6 | The height in feet of the intended insured person. | - |
Insured Height in Inches | height_inches | Number | No | 2 | The height in inches of the intended insured person. | - |
Second Insured Height in Feet | height_feet_2 | Number | No | 5 | If covering two people, the height in feet of the second insured. | - |
Second Insured Height in Inches | height_inches_2 | Number | No | 6 | If covering two people, the height in inches of the second insured. | - |
Insured Weight in Pounds | weight_pounds | Number | No | 180 | The weight in pounds of the intended insured person. | - |
Second Insured Weight in Pounds | weight_pounds_2 | Number | No | 170 | If covering two people, the weight in pounds of the second insured. | - |
Risk Profile (Only Variable Universal Life) | risk_profile | Multiple-Choice | No | Moderate | The risk appetite of the intended policy owner. Only applicable for Variable Universal Life. | Conservative, Moderate, Aggressive |
Expedited Product Preference | expedited_products | Boolean | No | false | Whether this request should be for a product with expedited underwriting, which are policies that can be issued in 1-2 days. | - |
Convertability Preference (Term life only) | convertability | Boolean | No | false | Whether a term life insurance should have the option to be converted into a permanent life insurance policy. | - |
Riders for the Plan | riders | Text | No | Paid Up Additions (Whole Life Only) | The riders that should be included in this plan. | Paid Up Additions (Whole Life Only), Guaranteed Insurability Rider, Waiver of Premium Rider, Terminal Illness Rider, Return of Premium Rider, Child Insurance Rider, Supplemental Term Rider, Charitable Benefit Rider, Overloan Protection Rider, No Lapse Guarantee Rider, Enhanced Cash Surrender Value Rider, Conversion Extension (Term Life Only), Chronic/Critical Illness Rider, Waiver of Premium Rider, Return of Premium Rider |
Supplemental Term Coverage Length | supplemental_term_length | Multiple-Choice | No | 10 Years | If Supplemental term is included as a rider, this value refers to the number of years that the supplemental term rider will cover the insured. | 10 Years, 20 Years, 30 Years, Life |
Supplemental Term Amount | supplemental_term_amount | Number | No | 100000 | If Supplemental term is included as a rider, this value refers to the amount of death benefit on the supplemental term rider. | - |
Room for additional premium | additional_premium_room | Number | No | 5000 | The amount of additional future premium that should be able to be paid for this plan while maintaining tax advantages. | - |
One-Time Deposit Amount | one_time_deposit_amount | Number | No | 10000 | The additional (if any) one-time amount that is planned to be deposited with the first premium of this policy. | - |
Uncapped Account Preference (Only Indexed Universal Life) | uncapped_accounts | Boolean | No | false | Whether requests for indexed universal life should include accounts without caps (ceiling on yearly crediting rate). | - |
Fee Account Preference (Only Indexed Universal Life) | fee_accounts | Boolean | No | false | Whether requests for indexed universal life should include accounts with fees, which may come with additional benefits. | - |
Planned Retirement Income | planned_retirement_income | Boolean | No | false | Whether the intended owner of this policy plans to use the policy to access retirement income. | - |
Starting Age of Retirement Income | retirement_start_age | Number | No | 65 | The age the intended owner intends to start distributing retirement income from this policy. | - |
Years of Retirement Income | retirement_length | Number | No | 20 | The amount of years the intended owner intends to distribute retirement income from this policy. | - |
Custom Allocation Mix | custom_account_allocation | Boolean | No | false | With this option selected as true, you can customize the recommended account allocations. If it is set to false, White Swan will recommend an appropriate allocation mix for this case. | - |
Cash Value Allocations | allocation_accounts | Object List | No | - | For Indexed Universal Life/Variable Universal Life, the accounts to which the cash value of this plan should initially be allocated to. | |
-Account Type | account_type | Multiple-Choice | No | Fixed Interest Account | The type of account/fund for this allocation slot. Note that account availability varies. | Fixed Interest Account, Domestic Indexed Accounts (Indexed Universal Life Only), International Indexed Accounts (Indexed Universal Life Only), Multi Indexed Accounts (Indexed Universal Life Only), Managed Volatility Accounts (Indexed Universal Life Only), Overall Index Funds (Variable Universal Life Only), Overall Specialty Funds (Variable Universal Life Only), Overall Bond Funds (Variable Universal Life Only), Overall Downside Protected Accounts (Variable Universal Life Only), S&P 500 Index Fund (Variable Universal Life Only), International Markets Funds (Variable Universal Life Only), Emerging Markets Funds (Variable Universal Life Only), Technology & Innovation Funds (Variable Universal Life Only), Real Estate Funds (Variable Universal Life Only), Healthcare Funds (Variable Universal Life Only), Energy Funds (Variable Universal Life Only), Utilities Funds (Variable Universal Life Only), Long Term Bond Funds (Variable Universal Life Only), High Yield Bond Funds (Variable Universal Life Only), Inflation Protected Bond Funds (Variable Universal Life Only), Index-linked Accounts (Variable Universal Life Only) |
-Allocation Percentage | allocation_percentage | Number | No | 50 | If custom allocation is selected, the percentage allocated to each account/fund. Note that for variable universal life, percentage allocations for all non Overall Allocation options indicate the allocation as a percentage of the allocation to that Overall category. | - |
White Swan Follow Up | ws_follow_up | Boolean | No | true | If this is set to true, White Swan will follow up with this client after the personal plan has been sent. | - |
Who Receives Communications for Case | coms_recipients | Multiple-Choice | No | Client & Me | This input could be used to control who receives communications related to this case. If left empty, both you and the client will receive communications. | Client & Me, Only Client, Only Me |
Plan Comment | request_comment | Text | No | I might want my wife covered under this plan too - let's discuss | This can be used to leave an optional comment for this case. | - |
When using the input to customize cash value allocations for variable universal life, bear in mind that percentages are defined on two levels - overall category allocation, and specific category component allocation. As an example for this, a 50% allocation to Overall Index Funds and a 50% allocation to S&P 500 Index Funds would result in an actual allocation of 25% to S&P 500 Index Funds.
Returned Parameters Specification:
Field Label | Field Key | Field Type | Example Value | Description |
---|---|---|---|---|
URL to Complete Request | url_to_complete_request | Text | https://app.whiteswan.io/get_started/your_page?request=1813426016 | URL for the user to complete the request. |
URL to View Request Internally | url_to_view_request | Text | https://app.whiteswan.io/partner_case/1813426016 | Internal URL to view the request. |
Plan Request Unique ID | request_id | Text | 20181342x96601656 | Unique ID for the plan request. |
Last updated