Insurer Policy API

Overview

Once the contract has been finalised and customer has accepted the offer from an insurer, there are two ways to process and place the policy document.

  • Finlex platform generates the document
  • Insurer generates and uploads the document

Generate policy document

In order to generate a policy document, it's required to design a policy template by the help of Finlex platform team and assign the template for the desired product. During the policy generation process the document template will be used to generate policy pdf document using on the style and content that is defined by the insurance company.

The template document can be as simple as a word document that should be provided to Finlex as a reference.


Generate Policy API

Returns the generated policy document.

GET https://{environment}/api/v1/tenders/:tender_id/issue-policy?format=base64

The response document formats are configurable.

  • Base64 String
  • Temporarily Access URL to read the file (URL expiry can be set up to 36 hours)

Query Parameters

NameTypeValues
formatStringBase64, URL (e.g. format=url)
expiryString1-36h (e.g. expiry=18h)



Upload policy document

Once a customer accepts the offer from insurance company, after finalising the covernote, Finlex platform will be ready to accept a policy document that can be uploaded using user interface.

🚧

Coming Soon

currently upload via API is not supported and only is available via Finlex Platform user interface.