Submit Complete Plan Request

PreviousStart Personal Plan Request NextCreate Pre-Fill Information

Last updated 14 days ago

This action can be used to create a highly tailored and customized plan request where the entire plan request experience is skipped.

This call has many more required fields than the Start Personal Plan Request action. If you don't want the end-user to go through the plan request but don't have enough information or want to make enough assumptions to provide all required fields for this action, you can use the Start Personal Plan Request action and have someone on your team go through the plan request on the behalf of the end-user.

To access instant quotes from this call, you first need to make sure that your BackNine integration is activated. Secondly, any instant quotes that may be generated from the call will not be returned in the API response. Instead, you will have to set up New Personal Plan Webhooks to receive these quotes asynchronously.

API Method:

Submit Complete Personal Plan Request

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

Submits a complete personal plan request.

Headers

Name

Type

Description

Request Body

Name

Type

Description

Sample Body Payload

{
"name": "John Doe",
"email": "john@doe.com",
"policy_type": "Variable Universal Life",
"main_goal": "Accumulation",
"phone": "123456789",
"resident_state": "Ohio",
"embed_url": false,
"death_benefit": 1000000,
"payment_schedule": "Monthly",
"paid_up_period": "10 Years",
"term_duration": "10 Years",
"premium_budget": 1000,
"gender": "Male",
"health_rating": "Excellent",
"date_of_birth": "20000123T012345.678+0900",
"tobacco": true,
"marijuana": true,
"height_feet": 6,
"height_inches": 5,
"weight_pounds": 100,
"risk_profile": "Aggressive",
"expedited_products": true,
"convertability": true,
"riders": [
    "Paid Up Additions (Whole Life Only)",
    "Waiver of Premium Rider"
],
"additional_premium_room": 0,
"one_time_deposit_amount": 0,
"custom_account_allocation": true,
"allocation_accounts": [
  {
      "account_type": "S&P 500 Fund (Variable Universal Life)",
      "allocation_percentage": "1"
  }
],
"uncapped_accounts": true,
"fee_accounts": true,
"planned_retirement_income": true,
"retirement_start_age": 60,
"retirement_length": 20,
"supplemental_term_amount": 1000000,
"supplemental_term_length": 10,
"extras": true,
"associated_person": "john@acme.com",
"redirect_url": "https://acme.com/success",
"ws_follow_up": true,
"coms_recipients": "Client & Me",
"contact_id": "918503x139058213",
"request_comment": "Make it really explosive for accumulation"
}

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 or plan goals.

Code Examples - Making the API Call:

curl -X POST "https://app.whiteswan.io/api/1.1/wf/complete_request" \
     -H "Authorization: Bearer <YOUR API KEY>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "User-Agent: <YOUR APP>" \
     -d '{
           "name": "John Doe",
           "email": "john@doe.com",
           "policy_type": "Term Life",
           "main_goal": "Protection",
           "resident_state": "Ohio",
           "death_benefit": 1000000,
           "payment_schedule": "Monthly",
           "term_duration": "10 Years",
           "gender": "Male",
           "health_rating": "Excellent",
           "date_of_birth": "20000123T012345.678+0900",
           "tobacco": true,
           "marijuana": true,
           "height_feet": 6,
           "height_inches": 5,
           "weight_pounds": 100,
           "convertability": true
         }'

import requests

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

data = {
    "name": "John Doe",
    "email": "john@doe.com",
    "policy_type": "Term Life",
    "main_goal": "Protection",
    "resident_state": "Ohio",
    "death_benefit": 1000000,
    "payment_schedule": "Monthly",
    "term_duration": "10 Years",
    "gender": "Male",
    "health_rating": "Excellent",
    "date_of_birth": "20000123T012345.678+0900",
    "tobacco": True,
    "marijuana": True,
    "height_feet": 6,
    "height_inches": 5,
    "weight_pounds": 100,
    "convertability": True
}

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

const url = "https://app.whiteswan.io/api/1.1/wf/complete_request";
const headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "user-agent": "<YOUR APP>"
};
const data = {
    name: "John Doe",
    email: "john@doe.com",
    policy_type: "Term Life",
    main_goal: "Protection",
    resident_state: "Ohio",
    death_benefit: 1000000,
    payment_schedule: "Monthly",
    term_duration: "10 Years",
    gender: "Male",
    health_rating: "Excellent",
    date_of_birth: "20000123T012345.678+0900",
    tobacco: true,
    marijuana: true,
    height_feet: 6,
    height_inches: 5,
    weight_pounds: 100,
    convertability: true
};

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));

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, "{\"name\":\"John Doe\",\"email\":\"john@doe.com\",\"policy_type\":\"Term Life\",\"main_goal\":\"Protection\",\"resident_state\":\"Ohio\",\"death_benefit\":1000000,\"payment_schedule\":\"Monthly\",\"term_duration\":\"10 Years\",\"gender\":\"Male\",\"health_rating\":\"Excellent\",\"date_of_birth\":\"20000123T012345.678+0900\",\"tobacco\":true,\"marijuana\":true,\"height_feet\":6,\"height_inches\":5,\"weight_pounds\":100,\"convertability\":true}");

        Request request = new Request.Builder()
            .url("https://app.whiteswan.io/api/1.1/wf/complete_request")
            .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

$ch = curl_init();

$data = array(
    "name" => "John Doe",
    "email" => "john@doe.com",
    "policy_type" => "Term Life",
    "main_goal" => "Protection",
    "resident_state" => "Ohio",
    "death_benefit" => 1000000,
    "payment_schedule" => "Monthly",
    "term_duration" => "10 Years",
    "gender" => "Male",
    "health_rating" => "Excellent",
    "date_of_birth" => "20000123T012345.678+0900",
    "tobacco" => true,
    "marijuana" => true,
    "height_feet" => 6,
    "height_inches" => 5,
    "weight_pounds" => 100,
    "convertability" => true
);

$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/complete_request");
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);
?>

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

uri = URI.parse("https://app.whiteswan.io/api/1.1/wf/complete_request")
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 = {
  name: "John Doe",
  email: "john@doe.com",
  policy_type: "Term Life",
  main_goal: "Protection",
  resident_state: "Ohio",
  death_benefit: 1000000,
  payment_schedule: "Monthly",
  term_duration: "10 Years",
  gender: "Male",
  health_rating: "Excellent",
  date_of_birth: "20000123T012345.678+0900",
  tobacco: true,
  marijuana: true,
  height_feet: 6,
  height_inches: 5,
  weight_pounds: 100,
  convertability: true
}

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

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

package main

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

func main() {
	url := "https://app.whiteswan.io/api/1.1/wf/complete_request"
	data := `{
		"name": "John Doe",
		"email": "john@doe.com",
		"policy_type": "Term Life",
		"main_goal": "Protection",
		"resident_state": "Ohio",
		"death_benefit": 1000000,
		"payment_schedule": "Monthly",
		"term_duration": "10 Years",
		"gender": "Male",
		"health_rating": "Excellent",
		"date_of_birth": "20000123T012345.678+0900",
		"tobacco": true,
		"marijuana": true,
		"height_feet": 6,
		"height_inches": 5,
		"weight_pounds": 100,
		"convertability": true
	}`

	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. 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.

Body Parameters Specification:

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.

Sample Return Payload

{
"url_to_view_request": "https://app.whiteswan.io/partner_case/john-doe",
"request_id": "169064082195x763050883821145600"
}

Returned Parameters Specification: