Submit Complete Plan Request
Last updated
Last updated
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:
POST
https://app.whiteswan.io/api/1.1/wf/complete_request
Submits a complete personal plan request.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
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:
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.
Returned Parameters Specification:
Field Label | Field Key | Field Type | Required | Example Value | Description | Alternatives (if Multiple-Choice) |
---|---|---|---|---|---|---|
Field Label | Field Key | Field Type | Example Value | Description |
---|---|---|---|---|