Create Pre-Fill Information

This action allows you to leverage your existing client data to enhance their user experience when applying for plans. It's recommended to set up this action to run from the trigger Started Plan Request or Completed Plan Request.

The pre-fill information needs to be linked with a plan request via ID, which can be done via providing plan request ID(s) in this action or by using the returned Pre-fill information ID returned from this call in conjunction with the Submit Complete Plan Request or Start Personal Plan Request action. Please note that there can only be one pre-fill information associated with each plan request. Ensure all necessary information is provided in a single action to avoid discrepancies.

Create Pre-Fill Information

Submits information that is used to pre-fill end-user applications.

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

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

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

Sample Body Payload

{
"requests_ids":["231085x32086","3806290x20862"],
"first_name": "John",
"middle_name": "A.",
"last_name": "Doe",
"gender": "Male",
"date_of_birth": "19950716T000000+0100",
"country_of_birth": "USA",
"state_of_birth": "California",
"phone": "123-456-7890",
"work_phone": "098-765-4321",
"email": "[e-mail]",
"address": "123 Main St, City, State, ZIP",
"us_citizen_resident": true,
"citizenship_details": "US Citizen",
"marital_status": "Married",
"drivers_license_number": "D1234567",
"drivers_license_state": "California",
"drivers_license_expiration_date": "19950716T000000+0100",
"ssn": "123-45-6789",
"occupation": "Software Engineer",
"employer": "TechCorp",
"years_at_job": 5,
"workplace_zip_code": "90001",
"best_time_call": "14:00",
"equal_split_death_benefit": false,
"beneficiaries": [
  {
    "beneficiary_custom_percentage": "100",
    "beneficiary_level": "Primary",
    "relationship_to_insured": "Spouse/Partner",
    "other_relationship_type": "Cousin",
    "entity_individual": "Individual",
    "person_name": "Jane Felicia Doe",
    "entity_name": "TechCorp LLC",
    "tax_id_ssn_ein_tin": "234-56-7890",
    "beneficiary_date_of_birth": "19950716T000000+0100",
    "beneficiary_phone_number": "321-654-0987",
    "same_address_as_insured": "true",
    "beneficiary_address": "29 Grand St, Oneonta, NY 13820, USA",
    "children_names": "Alice Doe,Bob Doe"
  }
],
"insurance_purpose": "Income Replacement",
"owner_insured_same": true,
"owner_type": "Individual",
"owner_insured_relationship": "Self",
"owner_name": "John Doe",
"owner_ein_tin": "123-45-6789",
"owner_entity_contact_person": "John Doe",
"owner_address": "123 Main St, City, State, ZIP",
"owner_email": "[e-mail]",
"owner_phone": "123-456-7890",
"owner_date_of_birth": "19950716T000000+0100",
"income_pay_premiums": true,
"premium_source": "Salary",
"owner_estimated_income": 100000,
"owner_spouse_estimated_income": 95000,
"household_total_assets": 500000,
"household_liquid_assets": 200000,
"household_total_liabilities": 100000,
"household_net_worth": 400000,
"owner_bankruptcy_history": false,
"backup_withholding": false,
"existing_policies": [
  {
    "insurance_carrier": "LifeCorp",
    "current_death_benefit": 500000,
    "policy_type": "Term Life",
    "policy_number": "LC123456",
    "year_issued": 2015,
    "replacement_reason": "Better Rates"
  }
],
"terminating_existing_policies": false,
"existing_policies_funding": false,
"temporary_insurance_coverage": true,
"accumulation_goal": "Accumulate cash value with caution",
"cash_access_timeline": "More than 20 years, if ever",
"normal_investment_expectation": "To have a high degree of stability, but only modest profits",
"poor_investment_expectation": "I would want a small profit",
"3yr_investment_expectation": "I would want a small profit",
"3m_investment_expectation": "I can tolerate small short-term losses"
}

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.

Code Examples - Making the API Call:

cURL

curl -X POST "https://app.whiteswan.io/api/1.1/wf/new_prefill_info" \
     -H "Authorization: Bearer <YOUR API KEY>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "User-Agent: <YOUR APP>" \
     -d '{
           "requests_ids": ["231085x32086", "3806290x20862"],
           "first_name": "John",
           "middle_name": "A.",
           "last_name": "Doe",
           "date_of_birth": "19950716T000000+0100",
           "address": "123 Main St, City, State, ZIP",
           "us_citizen_resident": true,
           "marital_status": "Married",
           "owner_estimated_income": 100000,
           "household_total_assets": 500000
         }'

Python

import requests

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

data = {
    "requests_ids": ["231085x32086", "3806290x20862"],
    "first_name": "John",
    "middle_name": "A.",
    "last_name": "Doe",
    "date_of_birth": "19950716T000000+0100",
    "address": "123 Main St, City, State, ZIP",
    "us_citizen_resident": True,
    "marital_status": "Married",
    "owner_estimated_income": 100000,
    "household_total_assets": 500000
}

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

Javascript

const url = "https://app.whiteswan.io/api/1.1/wf/new_prefill_info";
const headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "user-agent": "<YOUR APP>"
};
const data = {
    requests_ids: ["231085x32086", "3806290x20862"],
    first_name: "John",
    middle_name: "A.",
    last_name: "Doe",
    date_of_birth: "19950716T000000+0100",
    address: "123 Main St, City, State, ZIP",
    us_citizen_resident: true,
    marital_status: "Married",
    owner_estimated_income: 100000,
    household_total_assets: 500000
};

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, "{\"requests_ids\":[\"231085x32086\",\"3806290x20862\"],\"first_name\":\"John\",\"middle_name\":\"A.\",\"last_name\":\"Doe\",\"date_of_birth\":\"19950716T000000+0100\",\"address\":\"123 Main St, City, State, ZIP\",\"us_citizen_resident\":true,\"marital_status\":\"Married\",\"owner_estimated_income\":100000,\"household_total_assets\":500000}");

        Request request = new Request.Builder()
            .url("https://app.whiteswan.io/api/1.1/wf/new_prefill_info")
            .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(
    "requests_ids" => array("231085x32086", "3806290x20862"),
    "first_name" => "John",
    "middle_name" => "A.",
    "last_name" => "Doe",
    "date_of_birth" => "19950716T000000+0100",
    "address" => "123 Main St, City, State, ZIP",
    "us_citizen_resident" => true,
    "marital_status" => "Married",
    "owner_estimated_income" => 100000,
    "household_total_assets" => 500000
);

$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/new_prefill_info");
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/new_prefill_info")
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 = {
  requests_ids: ["231085x32086", "3806290x20862"],
  first_name: "John",
  middle_name: "A.",
  last_name: "Doe",
  date_of_birth: "19950716T000000+0100",
  address: "123 Main St, City, State, ZIP",
  us_citizen_resident: true,
  marital_status: "Married",
  owner_estimated_income: 100000,
  household_total_assets: 500000
}

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/new_prefill_info"
	data := `{
		"requests_ids": ["231085x32086", "3806290x20862"],
		"first_name": "John",
		"middle_name": "A.",
		"last_name": "Doe",
		"date_of_birth": "19950716T000000+0100",
		"address": "123 Main St, City, State, ZIP",
		"us_citizen_resident": true,
		"marital_status": "Married",
		"owner_estimated_income": 100000,
		"household_total_assets": 500000
	}`

	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:

Field Label	Field Key	Field Type	Required	Example Value	Description	Alternatives (if Multiple-Choice)
ID of Plan Request(s) to Associate Information With	requests_ids	Text	No	1813426016	The ID of the plan request(s) with which you want to associate this pre-fill information.	-
First Name	first_name	Text	No	John	The first name of the intended insured person.	-
Middle Name	middle_name	Text	No	A.	The middle name of the intended insured person.	-
Last Name	last_name	Text	No	Doe	The last name of the intended insured person.	-
Gender	gender	Multiple-Choice	No	Male	Whether the intended insured person is male or female.	Male, Female
Date of Birth	date_of_birth	DateTime	No	1990-01-01T00:00:00	The date of birth of the intended insured person.	-
Country of Birth	country_of_birth	Text	No	USA	The country of birth for the insured person.	-
State of Birth	state_of_birth	Text	No	CA	The US state where the insured was born.	-
Personal Phone	phone	Text	No	1234567890	The personal phone number of the applicant.	-
Workplace Phone	work_phone	Text	No	1234567890	The workplace phone number of the applicant.	-
Email	email	Text	No	[e-mail]	The email of the applicant.	-
Current Address	address	Address	No	123 Main St, City, State, Zip	The current address of the intended insured person.	-
Insured is US Citizen/Permanent Resident?	us_citizen_resident	Boolean	No	true	Whether the insured person is a US citizen or permanent resident.	-
Details on Citizenship (if not US citizen/resident)	citizenship_details	Text	No	Canadian Citizen	If the insured person isn't a US citizen/resident, this can be used to pre-fill where the insured person is currently a citizen or resident.	-
Marital Status	marital_status	Multiple-choice	No	Married	The marital status of the intended insured person.	Married, Divorced, Widowed, Never Married
Drivers License Number	drivers_license_number	Text	No	D1234567	The drivers license number of the insured person.	-
Drivers License State	drivers_license_state	Text	No	CA	The state of the drivers license of the insured person.	-
Drivers License Expiration Date	drivers_license_expiration_date	DateTime	No	1990-01-01T00:00:00	The expiration date of the drivers license of the insured person.	-
Social Security Number/Tax ID Number	ssn	Text	No	123-45-6789	The social security number or tax ID number of the intended insured person.	-
Current Occupation	occupation	Text	No	Software Engineer	The current occupation of the intended insured person.	-
Current Employer	employer	Text	No	TechCorp	The current employer of the intended insured person.	-
Number of Years at Current Job	years_at_job	Number	No	5	The amount of years that the insured has been employed at their current job.	-
Workplace Zip Code	workplace_zip_code	Text	No	90210	The zip code of the workplace of the insured.	-
Best Time to Call Intended Insured	best_time_call	Text	No	16:15:00	The time that is best for the insurance company to potentially call the insured person. Provide in format hh:mm:ss in military time, eg. 16:15:00	-
Split Death Benefit Equally	equal_split_death_benefit	Boolean	No	true	Whether the death benefit should be split equally between beneficiaries.	-
Beneficiaries	beneficiaries	Object List	No	-	-	-
-Percentage of Death Benefit	beneficiary_custom_percentage	Number	No	50	If death benefit is not split equally, the percentage of the death benefit to allocate to this beneficiary.	-
-Beneficiary Level	beneficiary_level	Multiple-Choice	No	Primary	Whether this is a primary or contingent beneficiary. Contingent beneficiaries receive death benefit when primary beneficiaries die.	Primary, Contingent
-Relationship to Insured	relationship_to_insured	Multiple-Choice	No	Spouse/Partner	The relationship between the intended beneficiary and the intended insured person.	Spouse/Partner, All Children of Insured, Equally, All Grandchildren of Insured, Equally, Other Relative, Business/Corporation, Charity, Trust, Other
-Type of Relationship (Other)	other_relationship_type	Text	No	Friend	If Other type of relationship, the nature of the relationship between the insured and the intended beneficiary.	-
-Legal Entity or Individual?	entity_individual	Multiple-Choice	No	Individual	If Other type of relationship, whether the intended beneficiary is an individual or an entity.	Individual, Entity
-Name of Children/Grandchildren	children_names	Text	No	John, Jane	If All Children/Grandchildren of Insured, Equally, the names of the children/grandchildren.	-
-Individual/Contact Person Name	person_name	Text	No	John Doe	The name of the intended beneficiary, or contact person at entity if this beneficiary is an entity.	-
-Entity Name	entity_name	Text	No	ABC Corp.	If this beneficiary is an entity, the name of the entity.	-
-Beneficiary SSN/EIN/TIN	tax_id_ssn_ein_tin	Text	No	123-45-6789	The tax ID of the intended beneficiary (SSN/TIN), or of the entity (EIN).	-
-Beneficiary Date of Birth	beneficiary_date_of_birth	DateTime	No	1990-01-01T00:00:00	If the beneficiary is an individual, the date of birth of the intended beneficiary.	-
-Beneficiary Phone Number	beneficiary_phone_number	Text	No	555-123-4567	The phone number of the intended beneficiary.	-
-Same Address as Insured?	same_address_as_insured	Boolean	No	False	Whether the intended beneficiary has the same address as the insured person.	-
-Address	beneficiary_address	Address	No	123 Main St, City, State, Zip	If beneficiary address is different from the insured, the address of the intended beneficiary.	-
Purpose of Insurance	insurance_purpose	Text	No	Income Replacement	The purpose of the death benefit of the policy, such as income replacement, legacy planning, or business continuation planning.	-
Owner Same as Insured?	owner_insured_same	Boolean	No	true	Whether the intended insured person and the intended policy owner is the same person.	-
Is Owner Individual or Entity?	owner_type	Text	No	Individual	If the owner is different from the insured, whether the person is an individual or entity.	-
Owner Relationship to Insured Person	owner_insured_relationship	Text	No	Spouse	If the owner is different from the insured, what the relationship is between the insured person and the owner.	-
Owner Individual/Entity Name	owner_name	Text	No	John Doe	If the owner is different from the insured, the entity name or individual name of the intended owner.	-
Owner EIN/TIN	owner_ein_tin	Text	No	12-3456789	If the owner is different from the insured, the EIN of the intended owner entity or the TIN of the intended owner individual.	-
Owner Entity Contact Person	owner_entity_contact_person	Text	No	Jane Smith	If the intended owner is an entity, the contact person for that entity.	-
Owner Address	owner_address	Address	No	456 Elm St, City, State, Zip	If the owner is different from the insured, the address of the intended owner.	-
Owner Email	owner_email	Text	No	[e-mail]	If the owner is different from the insured, the email address of the intended owner.	-
Owner Date of Birth	owner_date_of_birth	DateTime	No	1990-01-01T00:00:00	If the owner is different from the insured, the date of birth of the intended owner.	-
Will Owner Pay Premiums With Income?	income_pay_premiums	Boolean	No	False	Whether the owner plans to pay the premiums with income.	-
Source of Premium Payments	premium_source	Text	No	Savings	If the premiums are not planned to be paid with income, what the source of the premium is planned to be.	-
Owner Estimated Annual Income	owner_estimated_income	Number	No	75000	The estimated annual income of the intended insured person.	-
Spouse of Owner Estimated Annual Income	owner_spouse_estimated_income	Number	No	65000	If the intended owner is married, the estimated annual income of their spouse.	-
Household Estimated Total Assets	household_total_assets	Number	No	500000	The estimated total assets of the intended owner's household.	-
Household Estimated Liquid Assets	household_liquid_assets	Number	No	200000	The estimated liquid assets of the intended owner's household.	-
Household Estimated Total Liabilities	household_total_liabilities	Number	No	150000	The estimated total liabilities of the intended owner's household.	-
Has Owner Declared Bankruptcy	owner_bankruptcy_history	Boolean	No	False	Whether the intended owner has ever declared bankruptcy.	-
Bankruptcy Details	owner_bankruptcy_details	Text	No	Filed in 2010 due to medical expenses	If the owner has declared bankruptcy, details about the bankruptcy.	-
Has Owner Been Discharged From Bankruptcy	owner_bankruptcy_discharge	Boolean	No	True	If the owner has declared bankruptcy, whether the intended owner has been discharged.	-
Is Owner Subject to Backup Withholding?	backup_withholding	Boolean	No	False	Whether the intended owner is subject to backup withholding from the IRS.	-
Existing Policies on the Insured Person	existing_policies	Object List	No	-	-	-
-Insurance Carrier	insurance_carrier	Text	No	LifeGuard Insurance	The insurance carrier of this policy.	-
-Current Death Benefit	current_death_benefit	Number	No	100000	The current death benefit of this policy.	-
-Policy Type	policy_type	Text	No	Term Life	The policy type of this policy (eg. Term Life, Whole Life, Indexed Universal Life).	-
-Policy Number	policy_number	Text	No	LG123456	The policy number of this policy.	-
-Year Issued	year_issued	Number	No	2015	The year this policy was issued.	-
-Reason for Replacement	replacement_reason	Text	No	Better rates available	If a replacement of this policy is planned, what the reason for the replacement is.	-
-Replace or Terminate?	replace_or_terminate	Multiple-Choice	No	Terminate	If this policy is planned to be replaced or terminated.	Replace, Terminate
Plans to Terminate Existing Policies	terminating_existing_policies	Boolean	No	True	Whether the applicant plans on terminating or replacing any of the existing policies on the insured person.	-
Plans to Use Existing Policies to Fund New	existing_policies_funding	Boolean	No	False	Whether the applicant plans to use existing policies to fund premiums for this policy.	-
Opt for Temporary Insurance Coverage	temporary_insurance_coverage	Boolean	No	True	Whether the applicant wants to opt for temporary insurance coverage during applications and underwriting.	-
Accumulation Goal (Variable Universal Life Only)	accumulation_goal	Multiple-Choice	No	Accumulate cash value with caution	If this is for a variable universal life policy, what the overall accumulation goal is.	Avoid losing money, Accumulate cash value with caution, Accumulate cash value aggressively
Cash Access Timeline (Variable Universal Life Only)	cash_access_timeline	Multiple-Choice	No	5 to 20 years	If this is for a variable universal life policy, when the owner intends to access the cash value of the policy.	More than 20 years, if ever, 5 to 20 years, Less than 5 years
Normal Conditions Investment Expectations (Variable Universal Life Only)	normal_investment_expectation	Multiple-Choice	No	To trail the stock market, but make a moderate profit	If this is for a variable universal life policy, what investment results the owner would expect under normal market conditions.	To have a high degree of stability, but only modest profits, To trail the stock market, but make a moderate profit, To generally keep pace with the stock market
Poor Conditions Investment Expectations (Variable Universal Life Only)	poor_investment_expectation	Multiple-Choice	No	I want to at least break even	If this is for a variable universal life policy, what investment results the owner would expect under poor market conditions.	I would want a small profit, I want to at least break even, I would be willing to accept a loss
3 Year Investment Expectations (Variable Universal Life Only)	three_year_investment_expectation	Multiple-Choice	No	I want to at least break even	If this is for a variable universal life policy, what investment results the owner would expect for the next three years.	I would want a small profit, I want to at least break even, I would be willing to accept a loss
3 Month Investment Expectations (Variable Universal Life Only)	three_month_investment_expectation	Multiple-Choice	No	If I suffered a loss of greater than 10%, I'd get concerned	If this is for a variable universal life policy, what investment results the owner would expect for the next three months.	I can tolerate small short-term losses, If I suffered a loss of greater than 10%, I'd get concerned, One calendar quarter is too short for me to be concerned

---

Sample Return Payload

{
"success": true,
"prefill_info_id": "1691547056037x763566492663446900"
}

Returned Parameters Specification:

Field Name	Field Key	Field Type	Example Value	Description
Pre-Fill Information ID	prefill_info_id	Text	1691547056037x763566492663446900	The unique identifier for the pre-fill information that was created.
Success	success	Boolean	true	Whether the pre-fill information was created succesfully.