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

200: OK Call success

400: Bad Request Call failure

401: Unauthorized Permission denied

404: Not Found Not found

405: Method Not Allowed Wrong method

429: Too Many Requests Too many requests

500: Internal Server Error Internal bug

503: Service Unavailable Service unavailable

Sample Body Payload

{
"plan_id":"231085x32086",
"user_email": "[email protected]",
"client_email": "[email protected]"
}

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:

cURL

curl -X POST "https://app.whiteswan.io/api/1.1/wf/personal_plan" \
     -H "Authorization: Bearer <YOUR API KEY>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "User-Agent: <YOUR APP>" \
     -d '{
               "plan_id":"231085x32086",
               "user_email": "[email protected]",
               "client_email": "[email protected]"
          }'

Python

import requests

url = "https://app.whiteswan.io/api/1.1/wf/personal_plan"
headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "User-Agent": "<YOUR APP>"
}

data = {
    "plan_id":"231085x32086",
    "user_email": "[email protected]",
    "client_email": "[email protected]"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

Javascript

const url = "https://app.whiteswan.io/api/1.1/wf/personal_plan";
const headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "user-agent": "<YOUR APP>"
};
const data = {
    "plan_id":"231085x32086",
    "user_email": "[email protected]",
    "client_email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Java

import okhttp3.*;

public class WhiteSwanApiCall {

    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        MediaType mediaType = MediaType.parse("application/json");
        RequestBody body = RequestBody.create(mediaType, "{\"plan_id\":\"231085x32086\",\"user_email\":\"[email protected]\",\"client_email\":\"[email protected]\"}");

        Request request = new Request.Builder()
            .url("https://app.whiteswan.io/api/1.1/wf/personal_plan")
            .post(body)
            .addHeader("Authorization", "Bearer <YOUR API KEY>")
            .addHeader("Content-Type", "application/json")
            .addHeader("Accept", "application/json")
            .addHeader("user-agent", "<YOUR APP>")
            .build();

        try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

PHP

<?php

$ch = curl_init();

$data = array(
    "plan_id" => "231085x32086",
    "user_email" => "[email protected]",
    "client_email" => "[email protected]"
);

$headers = array(
    "Authorization: Bearer <YOUR API KEY>",
    "Content-Type: application/json",
    "Accept: application/json",
    "user-agent: <YOUR APP>"
);

curl_setopt($ch, CURLOPT_URL, "https://app.whiteswan.io/api/1.1/wf/personal_plan");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>

Ruby

require 'net/http'
require 'json'
require 'uri'

uri = URI.parse("https://app.whiteswan.io/api/1.1/wf/personal_plan")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

headers = {
  'Authorization' => 'Bearer <YOUR API KEY>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'User-Agent' => '<YOUR APP>'
}

data = {
    plan_id: "231085x32086",
    user_email: "[email protected]",
    client_email: "[email protected]"
}

request = Net::HTTP::Post.new(uri.path, headers)
request.body = data.to_json

response = http.request(request)
puts response.body

Go

package main

import (
	"bytes"
	"fmt"
	"net/http"
)

func main() {
	url := "https://app.whiteswan.io/api/1.1/wf/personal_plan"
	data := `{
    			"plan_id":"231085x32086",
    			"user_email": "[email protected]",
    			"client_email": "[email protected]"
		}`

	req, err := http.NewRequest("POST", url, bytes.NewBuffer([]byte(data)))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer <YOUR API KEY>")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("User-Agent", "<YOUR APP>")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	fmt.Println("Response Status:", resp.Status)
}

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	[email protected]	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	[email protected]	Can optionally be used to show personal plans associated with a particular client referred through your account.
Policy Search (Optional)	policy_search	Text	8052128065x89026589	Can optionally be used to only show personal plans that are associated with a particular policy search.

---

Sample Return Payload

[
        {
            "personal_plan_url": "https://app.whiteswan.io/personal_plan/john-doe-17",
            "client_name": "John Doe",
            "client_email": "[email protected]",
            "client_phone": "123456789",
            "intended_owner": "John Doe",
            "intended_insured": "John Doe",
            "expiration_date": "2025-08-26T14:28:39.345Z",
            "servicing_agent": {,
            "personal_message": "Hi John! I'm , and I'm here to help you through the process of getting a plan that suits your needs. While this quote has been automatically generated, I can find you a custom quote or answer any of your questions if you schedule a time with me or request a custom quote below.",
            "started_applied_for": false,
            "insurer": {
                "id": "",
                "name": "Transamerica",
                "logo": "//762d0145e332a78fcb6f9b9f529c26ab.cdn.bubble.io/f1715083057086x267225083770126200/transamerica.svg",
                "am_best_rating": "A",
                "established_year": 1961
            },
            "product": {
                "id": "",
                "name": "Trendsetter LB 20",
                "guaranteed_issue": false,
                "instant_decision_underwriting": false,
                "dual_insureds": false,
                "average_approval_time": "25 Days",
                "e_delivery": true,
                "binder_premium_payment_required": false,
                "convertible_to_permanent": true,
                "conversion_details": "For the entire term up to age 70 or age 75 for Preferred Plus. Conversions after the first five policy years can only convert to specific products.",
                "disclosure": "",
                "consumer_guide": "",
                "agent_guide": "",
                "underwriting_guide": ""
            },
            "illustration_pdf": "",
            "prospectus_pdf": null,
            "term_length": "20 Years",
            "term_length_numerical": 20,
            "assumed_annual_return": null,
            "initial_death_benefit": 1000000,
            "premium_modality": "Monthly",
            "recurring_premium": 47.3,
            "one_time_deposit": 0,
            "policy_type": "Term Life",
            "main_goal": "Protection",
            "health_rating": "Super Preferred",
            "annual_retirement_income": null,
            "total_retirement_income": null,
            "years_of_retirement_income": null,
            "annual_target_premium": null,
            "annual_total_premium": 567.6,
            "paid_up_period": "20 Years",
            "paid_up_period_numerical": 20,
            "guaranteed_projected_cash_values": null,
            "non_guaranteed_projected_cash_values": null,
            "projected_death_benefits": null,
            "future_cash_values_irr": null,
            "future_death_benefits_irr": null,
            "riders": [],
            "allocation_accounts": [],
            "monthly_ltc_benefit": null,
            "ltc_pool_of_money": null,
            "ltc_elimination_period": null,
            "ltc_benefit_limit": null,
            "shared_care_rider": false,
            "joint_waiver_of_premium": false,
            "home_health_care_rider": false,
            "ltc_discounts": [
                "No Employer/Association Discount",
                "Partner/Spouse Discount"
            ],
            "conversion_privilege_expiration_date": null,
            "medical_exam_required_underwriting": "Exam Possibly Required",
            "medical_exam_details": "Based on your answers to underwriting questions, an exam may or may not be required.",
            "plan_id": "1756132139593x400146733315550850",
            "associated_request_id": "1756132113128x587035433367457300"
        }
]

Returned Parameters Specification:

Field Label	Field Key	Field Type	Example Value	Description	Options (if Multiple-Choice)
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	[email protected]	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.	-
Personal Message	personal_message	Text	Hi John! By comparing several options...	Personalized message from the success manager to the client.	-
Started Applied For	started_applied_for	Boolean	false	Indicates whether an application has been started for this plan.	-
Insurer	insurer	Object	-	The insurer associated with this quote.	-
Insurer ID	id	Text	2	The ID of the insurance carrier.	-
Insurer Name	name	Text	John Hancock	The name of the insurance carrier.	-
Insurer Logo	logo	Text	https://s3.amazonaws.com/appforest_uf/f1660780457493x297075060123930300/john%20hancock%20Logo.png	A logo image file of the insurance carrier associated with this plan.	-
Product	product	Object	-	The specific insurance carrier policy that it associated with this quote.	-
Product Name	name	Text	Sample Policy	Name of the insurance product.	-
Product ID	id	Text	2	The ID of the insurance product.	-
Guaranteed Issue	guaranteed_issue	Yes/No	true	Indicates whether the product can be issued without medical underwriting, regardless of the applicant’s health status.	-
Instant Decision Underwriting	instant_decision_underwriting	Yes/No	true	Specifies if the product supports instant decisioning (approval or decline within minutes) based on digital application data.	-
Dual Insureds	dual_insured	Yes/No	true	Shows whether the policy covers two insured individuals under the same contract (e.g., survivorship or joint policies).	-
Average Approval Time	average_approval_time	Text	25 Days	The typical time it takes for the carrier to issue a policy, from application submission to approval (e.g., “25 Days”).	-
E-delivery Status	e_delivery	Yes/No	true	Indicates if the carrier supports electronic delivery of policy documents rather than requiring physical mail.	-
Binder Premium Payment	binder_premium_payment_required	Yes/No	true	Specifies whether an initial premium payment is required to bind coverage at the time of application.	-
Convertability to permanent policy	convertible_to_permanent	Yes/No	true	Indicates whether a term policy can be converted into a permanent life insurance product without additional underwriting.	-
Conversion Privilege Details	conversion_details	Text	For the entire term up to age 70 or age 75 for Preferred Plus. Conversions after the first five policy years can only convert to specific products.	Carrier-specific rules and limitations about policy conversion options (e.g., eligible products, time windows, age limits).	-
Insurer Disclosure	disclosure	Text	Approval and actual premiums will be based upon the entire underwriting process, including but not limited to, information provided on the application, exam results and specific underwriting requirements and criteria. OPTerm 10 issue ages are 20-75 all classes...	General disclosure statement or carrier-provided text about the product’s terms, limitations, or conditions.	-
Consumer Guide PDF	consumer_guide	Text	https://762d0145e332a78fcb6f9b9f529c26ab.cdn.bubble.io/f1724676961276x174429020343094940/resource.pdf	URL to the carrier’s official consumer guide for the product, intended for clients.	-
Agent Guide PDF	agent_guide	Text	https://762d0145e332a78fcb6f9b9f529c26ab.cdn.bubble.io/f1724676961276x174429020343094940/resource.pdf	URL to the carrier’s agent-facing guide, containing details needed for producers to sell and manage the product.	-
Underwriting Guide PDF	underwriting_guide	Text	https://762d0145e332a78fcb6f9b9f529c26ab.cdn.bubble.io/f1724676961276x174429020343094940/resource.pdf	URL to the underwriting guide with rules, requirements, and processes carriers follow during risk assessment.	-
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.	-
Guaranteed Cash Values	guaranteed_projected_cash_values	Number List	0,100,200,500...	The guaranteed future cash values, with each value representing one year.	-
Projected Non-Guaranteed Cash Values	non_guaranteed_projected_cash_values	Number List	1000,1200,1300,1400...	The projected, non-guaranteed future cash values, with each value representing one year.	-
Servicing Agent	servicing_agent	Object	-	The agent assigned to the case.	-
Name	name	Text	John Doe	The agent's name.	-
Email	email	Text	[email protected]	The agent's email.	-
Phone	phone	Text	123456789	The agent's phone number.	-
Meeting Link	meeting_link	Text	https://calendly.com/johndoe	The agent's meeting scheduling link.	-
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.	-
Monthly LTC Benefit	monthly_ltc_benefit	Number	10000	The maximum monthly dollar amount available for Long-Term Care (LTC) expenses. Null if not applicable to the product.	-
LTC Pool of Money	ltc_pool_of_money	Number	1000000	The total lifetime dollar amount available for LTC benefits. Benefits are paid out of this pool until it is depleted.	-
LTC Elimination Period	ltc_elimination_period	Multiple-Choice	1 Year	The waiting period before LTC benefits become payable after a qualifying event. Null if not applicable.	Immediately, 30 Days, 60 Days, 90 Days, 180 Days, 1 Year
LTC Benefit Limit	ltc_benefit_limit	Multiple-Choice	2 Years	The maximum limit applied to recieved LTC benefits.	2 Years, 3 Years, 4 Years, 5 Years, 6 Years, 7 Years, 8 Years, For Life
Share Care Rider	shared_care_rider	Yes/No	true	Indicates whether the policy offers a shared care rider, allowing two insured individuals (often spouses) to share their LTC benefit pools.	-
Joint Waiver of Premium	joint_waiver_of_premium	Yes/No	true	Specifies whether the policy includes a joint waiver of premium, waiving payments if one insured qualifies for benefits under certain conditions.	-
Home Health Care Rider	home_health_care_rider	Yes/No	true	Indicates whether the policy includes a rider covering care received at home instead of in a facility.	-
LTC Discounts	ltc_discounts	List of Multiple-Choice	["Two Spouses/Partners Applying","Employer"]	Lists applicable LTC-related premium discounts, such as employer-based discounts or partner/spouse discounts.	No Partner/Spouse, One Spouse/Partner Applying, Two Spouses/Partners Applying, No Employer/Association, Employer, Association
Term Conversion Privilege Expiration Date	conversion_privilege_expiration_date	Date	20260716T000000+0200	The date until which the term policy is eligible for conversion into a permanent life insurance policy. Null if the feature does not apply.	-
Medical Exam Required Status	medical_exam_required_underwriting	Text	Exam Not Required	High-level indicator of whether a medical exam is required for underwriting (e.g., “Exam Required,” “No Exam,” “Exam Possibly Required”).	-
Medical Exam Required Details	medical_exam_details	Text	You won't need an exam, phone call, or your medical records reviewed.	Additional carrier-specific information about medical exam requirements, conditions, or exceptions for underwriting.	-