Plan Request(s)

The Plan Request Search action allows you to retrieve information about one or several plan requests through your White Swan account.

Plan request information is also available via case tracking pages.

API Method:

Fetch Plan Request(s)

POST https://app.whiteswan.io/api/1.1/wf/plan_requests

Returns information about plan requests 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

{
"request_id":"231085x32086",
"user_email": "[e-mail]",
"client_email": "[e-mail]"
}

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/plan_requests" \
     -H "Authorization: Bearer <YOUR API KEY>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "User-Agent: <YOUR APP>" \
     -d '{
               "request_id":"231085x32086",
               "user_email": "[e-mail]",
               "client_email": "[e-mail]"
          }'

Python

import requests

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

data = {
    "request_id":"231085x32086",
    "user_email": "[e-mail]",
    "client_email": "[e-mail]"
}

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

Javascript

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

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, "{\"request_id\":\"231085x32086\",\"user_email\":\"[e-mail]\",\"client_email\":\"[e-mail]\"}");

        Request request = new Request.Builder()
            .url("https://app.whiteswan.io/api/1.1/wf/plan_requests")
            .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(
    "request_id" => "231085x32086",
    "user_email" => "[e-mail]",
    "client_email" => "[e-mail]"
);

$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/plan_requests");
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/plan_requests")
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 = {
    request_id: "231085x32086",
    user_email: "[e-mail]",
    client_email: "[e-mail]"
}

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/plan_requests"
	data := `{
    			"request_id":"231085x32086",
    			"user_email": "[e-mail]",
    			"client_email": "[e-mail]"
		}`

	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
Request ID (Optional)	request_id	Text	11890562x825608	Can optionally be provided to retrieve information about a specific plan request.
Account User Email (Optional)	user_email	Text	[e-mail]	Can optionally be provided to show plan requests associated with a particular user in your account.
Client Email (Optional)	client_email	Text	[e-mail]	Can optionally be provided to show plan requests associated with a particular client referred through your White Swan account.

---

Sample Return Payload

[{
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "[e-mail]",
"policy_type": "Variable Universal Life",
"url_to_view_request_plans": "https://app.whiteswan.io/personal_plan/john-doe",
"url_to_view_request_internally": "https://app.whiteswan.io/partner_case/john-doe",
"url_to_finish_request": "https://app.whiteswan.io/get_started?block=c&request=1810952036992517125",
"main_goal": "Accumulation",
"phone": "1234567890",
"resident_state": "Florida",
"request_comment": "Would like to discuss investment account options",
"plan_success_manager": "Eric Mikolai",
"plan_success_manager_email": "[e-mail]",
"plan_success_manager_phone": "1234567890",
"plan_success_manager_meeting_link": "https://calendly.com/eric_whiteswan/personal-plan-review",
"associated_partner_account": "Acme Inc",
"associated_partner_user": "Jane Doe",
"associated_partner_page": "Variable Universal Life Company Page",
"death_benefit": 1000000,
"payment_schedule": "Monthly",
"paid_up_period": "10 Years",
"paid_up_period_numerical": 10,
"term_duration": "10 Years",
"term_duration_numerical": 10,
"premium_budget": 10000,
"gender": "Male",
"health_rating": "Excellent",
"date_of_birth": "2022-08-16T22:00:00.000Z",
"risk_profile": "Aggressive",
"expedited_products": true,
"convertability": false,
"riders": [
  "Waiver of Premium Rider",
  "Terminall Illness Rider",
  "Return of Premium Rider",
  "Supplemental Term Rider"
],
"additional_premium_room": 0,
"one_time_deposit_amount": 0,
"uncapped_accounts": "Capped Accounts",
"fee_accounts": "No Fee Accounts",
"planned_retirement_income": true,
"retirement_start_age": 60,
"retirement_length": 20,
"custom_account_allocation": true,
"account_allocations": [
  {
    "account_name": "Real Estate Fund",
    "allocation_percentage": 0.6
  },
  {
    "account_name": "Technology & Innovation Fund",
    "allocation_percentage": 0.4
  }
],
"personal_plan_ids": [
  "21859x36990",
  "218590x369356"
],
"request_id": "1690640821195x3690508838211456001"
}]

Returned Parameters Specification:

Field Label	Field Key	Field Type	Example Value	Description
Client Full Name	name	Text	John Doe	Full name of the client
Client First Name	first_name	Text	John	First name of the client
Client Last Name	last_name	Text	Doe	Last name of the client
Client Email	email	Text	[e-mail]	Email address of the client
URL To View Plan(s) For Request	url_to_view_request_plans	Text	https://app.whiteswan.io/personal_plan/john-doe	The URL to view the personal plan(s) associated with this plan, if available.
URL To View Request Internally	url_to_view_internally	Text	https://app.whiteswan.io/partner_case/john-doe	The URL to view the request inside your White Swan account (not the interface intended for the end-user).
URL To Finish Request	url_to_finish_request	Text	https://app.whiteswan.io/get_started/john-doe	If this plan request hasn't been finished, the URL to finish filling out the request.
Request Policy Type	policy_type	Text	Variable Universal Life	Type of policy requested
Request Main Goal	main_goal	Text	Accumulation	Main goal of the request
Client Phone Number	phone	Text	1234567890	Phone number of the client
Insured Resident State	resident_state	Text	Florida	State of residence of the insured
Plan Request Comment	request_comment	Text	Would like to discuss investment account options	Additional comments or details regarding the plan request
Plan Success Manager Name	plan_success_manager	Text	Eric Mikolai	Name of the manager handling the plan
Plan Success Manager Email	plan_success_manager_email	Text	[e-mail]	Email of the manager handling the plan
Plan Success Manager Phone	plan_success_manager_phone	Text	1234567890	Phone number of the manager handling the plan
Plan Success Manager Meeting Link	plan_success_manager_meeting_link	Text	https://calendly.com/eric_whiteswan/personal-plan-review-	Link to schedule a meeting with the manager
Referring Partner Company	associated_partner_account	Text	Acme Inc	Name of the partner company that referred the client
Referring Partner User	associated_partner_user	Text	Jane Doe	Name of the user associated with the page/custom case of this request
Referring Partner Page/Custom Case	associated_partner_page	Text	Variable Universal Life Company Page	Page/custom case from the partner company that referred the client
Request Death Benefit Need	death_benefit	Number	1000000	Amount of death benefit requested
Request Payment Schedule	payment_schedule	Text	Monthly	Payment schedule for the policy
Request Paid up Period (Text)	paid_up_period	Text	10 Years	Duration after which no more premiums need to be paid
Request Paid up Period (Number)	paid_up_period_numerical	Number	10	Numerical representation of the paid-up period
Request Term Length (Text, Term Life Only)	term_duration	Text	10 Years	Duration of the term life policy
Request Term Length (Number, Term Life Only)	term_duration_numerical	Number	10	Numerical representation of the term duration
Request Premium Budget (Accumulation Requests Only)	premium_budget	Number	10000	Budget for the policy premium
Insured Gender	gender	Text	Male	Gender of the insured
Insured Health Rating	health_rating	Text	Excellent	Health rating of the insured
Insured Date of Birth	date_of_birth	Datetime	2022-08-16T22:00:00.000Z	Date of birth of the insured
Insured Investment Risk Profile (Variable Universal Life Only)	risk_profile	Text	Aggressive	Investment risk profile for variable universal life policies
Request Expedited Product Preference	expedited_products	True/False	True	Preference for expedited products
Request Convertability Preference (Term Life Only)	convertability	True/False	False	Preference for convertibility in term life policies
Rider Name	riders	List	Waiver of Premium Rider, ...	Names of the riders chosen
Request Room for Additional Future Premium	additional_premium_room	Number	0	Additional room for future premium payments
Request One Time Deposit Amount	one_time_deposit_amount	Number	0	Amount for one-time deposit
Request Account Cap Preference (Indexed Universal Life Only)	uncapped_accounts	Text	Capped Accounts	Preference for account cap in indexed universal life policies
Request Fee Accounts Preference (Indexed Universal Life Only)	fee_accounts	Text	No Fee Accounts	Preference for fee accounts in indexed universal life policies
Request Plan for Retirement Income	planned_retirement_income	True/False	True	Preference to plan for retirement income
Request Retirement Income Start Age	retirement_start_age	Number	60	Age at which retirement income starts
Request Retirement Income Amount of Years	retirement_length	Number	20	Duration of retirement income
Request Customized Account Allocation	custom_account_allocation	True/False	True	Preference for customized account allocation
Account Allocations	account_allocations	Line Item(s)	-	For Variable/Indexed Universal Life, the types of accounts/funds the cash value of this plan is initially allocated to.
-Account/Fund Name	account_name	Text	Long-Term Bond Fund	Names of the account/fund type
-Account/Fund Allocation Percentage	allocation_percentage	Text	0.15	Allocation percentages for the account/fund type
Personal Plan ID(s)	personal_plan_ids	List	1690640821195x763050883821145600	The ID(s) of any personal plans associated with this Quote Request.
Plan Request ID	request_id	Text	1690640821195x763050883821145600	Unique identifier for the plan request