Go to AppGet in Touch

Illustration

This endpoint returns an insurance illustration associated with a particular personal plan.

API Method:

Fetch Illustration

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

Returns the illustration as a base64 file. Convert the base64 content into PDF and save it securely to simplify access.

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
{
"plan_id":"1767096204345x539887650377297600"
}

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

plan_id

Text

1767096204345x539887650377297600

The ID of the plan for which you want to fetch an illustration.

Sample Return Payload

Returned Parameters Specification:

Field Label
Field Key
Example Value
Description

File Name

file_name

Nationwide Care Matters 2 - Lifetime Pay for John Doe.pdf

The name of the file.

Content Type

content_type

application/pdf

The content type of the file.

Base 64 Data

data_base64

data:application/pdf;base64,JVBERi0xLjcNCiX5+prnDQolQUJDcGRmID...

The base64 representation of the file.

PreviousPolicy SearchNextOverview of White Swan Embed

Last updated

Was this helpful?