Policy Search

The policy search endpoint can be used to fetch quotes when you're requesting full quotes through the Submit Complete Plan Request. After calling the complete plan request endpoint with a valid body to get quotes, a policy search ID will be returned which you can use to poll the Policy Search endpoint and get access to data like status, quotes, and errors.

API Method:

Policy Search

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

Returns information about a policy search.

Headers

Name

Type

Description

Authorization*

String

Bearer <YOUR API KEY>

Content-Type*

String

application/json

Accept*

String

application/json

user-agent*

String

Request Body

Name

Type

Description

JSON Body*

Object

See specification below

Sample Body Payload

{
"policy_search":"1755962938878x653642511385623700"
}

Code Examples - Making the API Call:

curl -X POST "https://app.whiteswan.io/api/1.1/wf/policy_search" \
     -H "Authorization: Bearer <YOUR API KEY>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "User-Agent: <YOUR APP>" \
     -d '{
               "policy_search": "1755962938878x653642511385623700"
          }'

import requests

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

data = {
    "policy_search": "1755962938878x653642511385623700"
}

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

const url = "https://app.whiteswan.io/api/1.1/wf/policy_search";
const headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "user-agent": "<YOUR APP>"
};
const data = {
    "policy_search": "1755962938878x653642511385623700"
};

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, "{\"policy_search\":\"1755962938878x653642511385623700\"}");

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

$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/policy_search");
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/policy_search")
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 = {
    policy_search: "1755962938878x653642511385623700"
}

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/policy_search"
	data := `{
    			"policy_search" : "1755962938878x653642511385623700"
		}`

	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

Policy Search

policy_search

Text

1755962938878x653642511385623700

The ID of the policy search to poll.

Sample Return Payload

{
    "policy_search_id": "1755962938878x653642511385623700",
    "status": "Found Policies",
    "linked_plan_request": "1755962937306x171818994560791740",
    "policy_type": "Term Life",
    "goal": "Protection",
    "death_benefit": 1000000,
    "premium_budget": null,
    "policies": [
        {
            "personal_plan_url": "https://app.whiteswan.io/personal_plan/john-doe-16",
            "client_name": "John Doe",
            "client_email": "[email protected]",
            "client_phone": "123456789",
            "intended_owner": "John Doe",
            "intended_insured": "John Doe",
            "expiration_date": "2025-08-24T15:29:00.816Z",
            "servicing_agent": {
                "name": "Jane Smith",
                "email": "[email protected]",
                "phone": "123 435 9610",
                "meeting_link": "https://meet.com"
            },
            "personal_message": "Hi John! I'm Jane, 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": {
                "name": "North American",
                "logo": "//762d0145e332a78fcb6f9b9f529c26ab.cdn.bubble.io/f1715082967264x994153174517765200/north_american_reduced_size_square%20%281%29%201.svg",
                "am_best_rating": "A+",
                "established_year": 1886
            },
            "product": {
                "name": "ADDvantage 20 (guar 20)",
                "guaranteed_issue": false,
                "instant_decision_underwriting": false,
                "dual_insureds": false,
                "average_approval_time": "44 Days",
                "e_delivery": true,
                "binder_premium_payment_required": false,
                "convertible_to_permanent": true,
                "conversion_details": "To any permanent product throughout the level term period or through age 70, whichever is earlier. However, the conversion period is never less than five years, regardless of issue age!",
                "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": 110,
            "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": 1320,
            "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 Is Required",
            "medical_exam_details": "requires a complimentary exam. In a few steps you'll schedule your exam at a time and place convenient for you.",
            "plan_id": "1755962955969x276667317413269220",
            "associated_request_id": "1755962937306x171818994560791740"
        }
    ],
    "error_message": ""
}

Returned Parameters Specification:

Field Label

Field Key

Field Type

Example Value

Description

Alternatives (if Multiple-Choice)

Policy Search ID

policy_search_id

Text

1755962938878x653642511385623700

The ID of the policy search that is being polled.

Status

status

Multiple-Choice

Found Policies

The current status of the policy search.

Found Policies, Fetching Quotes, No Policies Found

Linked Plan Request ID

linked_plan_request

Text

1755962937306x171818994560791740

The ID of the plan request that is associated with this policy search.

Policy Type

policy_type

Multiple-choice

Term Life

The policy type associated with this policy search.

Term Life, Return of Premium Term Life, Guaranteed Universal Life, Whole Life, Indexed Universal Life, Variable Universal Life, Private Placement Life, Final Expense, Linked Benefit, Long Term Care, Accidental Death

Goal

goal

Multiple-choice

Protection

The goal of this policy search.

Protection, Balanced, Accumulation

Death Benefit

death_benefit

Number

1000000

The amount of death benefit sought after in this policy search.

Premium Budget

premium_budget

Number

1000

The target premium budget associated with this policy search.

Policies

policies

Personal Plan Object List

A list of the policies found for this policy search. See full data structure of policy objects on the Personal Plan page.

Error Message

error_message

Text

If we had any errors with finding policies based on the input for this policy search, you can access details here.

URL To View Quotes

policies_view_url

Text

https://app.whiteswan.io/get_started/1756132114502x277128707509505020?policy_search=1756132116084x494781508118696400&request=1756132113128x587035433367457300&block=s

A URL where the list of policies, if any, can be viewed.

PreviousEarnings Event(s)NextOverview of BackNine Integration

Last updated 2 days ago

Was this helpful?