Start Application

The start application endpoint can be used to start an application for a certain personal plan. It is especially helpful for more sophisticated API integrations where you have your own interface to visualize policies and want to process applications either through an embed in your own environment or through linking out to a White Swan hosted policy application page.

If you're pre-filling an application, Create the Pre-fill Information before you start an application.

If you've created a quote via API but plan to process the application via the White Swan hosted application page, be aware that the White Swan hosted page is protected through two factor authentication. To ensure your users can access the page you need to either provide their email/phone when creating the plan request or Add Case Parties.

If you're using the embed code, fetch it at or close to page load, as the embed code needs to be loaded within 30 seconds to avoid the user having to authenticate through putting the date of birth of the insured in.

API Method:

Start Application

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

Initiates an application for a particular personal plan under a plan request.

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

{
    "plan" : "1755826501569x292619937398346240"
}

Code Examples - Making the API Call:

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

import requests

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

data = {
    "plan": "1755826501569x292619937398346240"
}

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

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

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, "{\"plan\":\"1755826501569x292619937398346240\"}");

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

$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/start_application");
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/start_application")
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: "1755826501569x292619937398346240"
}

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/start_application"
	data := `{
    			"plan" : "1755826501569x292619937398346240"
		}`

	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

Plan

plan

Text

1755962938878x653642511385623700

The ID of the plan to start an application for.

Sample Return Payload

{
    "url_to_apply": "https://app.whiteswan.io/apply/1756132113128x587035433367457300",
    "embed_code": "<div id=\"container-id\"></div><script id=\"strife\" src=\"https://cdn.quoteandapply.io/widget.js?prefill&eapp_id=447406&eapp_uuid=a4e283c1-8b37-4b58-a695-dbbf244e7d7d&products=[]#resume=WGFiMXY3ejdGRUVzVmxHYVZ0NEFTendybFh3SFRrdEdUTk9pL3M1SzZzS3RvYWthekpocEVMeGd4eWJVQS83SjllUVo0N2pZRm16Zi9WSEd4ZWxQUVduTWdtRkNMRWZmZDJseTN2MS84eENTTk50d0RNK2tXSXBiYTl6eC0tVW8rS3c1U1BQQ3ZnQ25YSC0tZXl0REtocEVNNU5LOGw0MGNOYmNvQT09\" data-strife-key=\"Omd010LUl8Yca9g3\" data-strife-container-id=\"container-id\"></script>",
    "plan": "1756132123417x732274886961195500",
    "quote_request": "1756132113128x587035433367457300"
}

Returned Parameters Specification:

Field Label

Field Key

Field Type

Example Value

Description

White Swan Application URL

url_to_apply

Text

https://app.whiteswan.io/apply/1756132113128x587035433367457300

The URL or the White Swan hosted page that can be used to process the application.

Application Embedding Code

embed_code

Escaped HTML

<div id=\"container-id\"></div><script id=\"strife\" src=\"https://cdn.quoteandapply.io/widget.js?prefill&eapp_id=447406&eapp_uuid=a4e283c1-8b37-4b58-a695-dbbf244e7d7d&products=[]#resume=WGFiMXY3ejdGRUVzVmxHYVZ0NEFTendybFh3SFRrdEdUTk9pL3M1SzZzS3RvYWthekpocEVMeGd4eWJVQS83SjllUVo0N2pZRm16Zi9WSEd4ZWxQUVduTWdtRkNMRWZmZDJseTN2MS84eENTTk50d0RNK2tXSXBiYTl6eC0tVW8rS3c1U1BQQ3ZnQ25YSC0tZXl0REtocEVNNU5LOGw0MGNOYmNvQT09\" data-strife-key=\"Omd010LUl8Yca9g3\" data-strife-container-id=\"container-id\"></script>

HTML code that you can use to embed an application form in your own environment. Beware that the HTML is escaped so that it can safely be passed inside a JSON body and that you should unescape it before using it in your own environment.

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.

Goal

goal

Multiple-choice

Protection

The goal of this policy search.

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.

PreviousCreate Pre-Fill Information NextAdd Case Party

Last updated 5 months ago

Was this helpful?

hashtagStart Application

hashtagHeaders

hashtagRequest Body

Start Application

Headers

Request Body