Broker Tender API
The tender object is the medium of communication between brokers, Insurance providers, and end-user (customers) from risk assessment to accepting an offer and closing it by sealing a policy.
Every tender object has many properties and associations that are available in responses from Tender API. Here it's possible to understand the meaning and usage of each property.
Create New Tender
Coming Soon
Create new tender is currently only available via Finlex Platform User Interface.
List Tenders
curl https://{environment}/api/v1/tenders \
-H "Authorization: Bearer {ACCESS_TOKEN}"
// List of tenders
{
"metadata": {
"count": "1",
"sort": {},
"skip": "0",
"limit": "50"
},
"payload": [{
"_id": "63dd2f6134fb03000831b475",
"changes_metadata": {
"status_changed_to_quotes_available": "2023-02-03T16:00:53.972Z"
},
"created_at": "2023-02-03T15:59:29.208Z",
"product": "Special D&O Product",
"status": "QUOTES_AVAILABLE",
"tax_rate": 0.19,
"updated_at": "2023-02-03T16:00:53.990Z",
"line_of_business": {
"_id": "8qjpJ2RE6AHhMiksB",
"name": "Cyber Versicherung"
},
"customer": {
"_id": "63da8d4466d10900066b26af",
"address": {
"street": "",
"house_number": "",
"zip": "zg",
"city": "",
"country": "DE"
},
"company_id": "63da8d4466d10900066b26af",
"name": "Ms test test"
},
"broker_company": {
"_id": "COMiDryfjsB8A",
"address": {
"street": "C Isaac Albeniz 9 4 28 - La Pineda",
"house_number": "/",
"zip": "23455",
"city": "Vila-seca",
"country": "DE"
},
"company_id": "COMiDryfjsB8A",
"email": "[email protected]",
"name": "Broker Q"
},
"person_in_charge": {
"_id": "ACCjIBsnvffox",
"account_id": "ACCjIBsnvffox",
"email": "[email protected]",
"first_name": "Broker",
"last_name": "Q1",
"salutation": "Mrs"
}
}]
}
Open Tenders
Returns the list of tenders which are QUOTES_AVAILABLE, IN_NEGOTIATION, IN_COVERNOTE or REOPENED and are not closed yet
GET https://{environment}/public/v1/tenders/open
Successful Tenders
Returns the list of tenders which are SUCCESSFUL and the contract has been finalised.
GET https://{environment}/api/v1/tenders/successful
Important Note
Successful tender is in the latest state, Insurer companies should finalise and confirm the policy documentation.
Closed
Returns the list of tenders which are CLOSED and no further action is required.
GET https://{environment}/api/v1/tenders/closed
Important Note
Closed tenders might be unsuccessful or simply closed by the broker. Further information can't be shared with insurers due to data privacy.
JSON Format
Tenders are represented as JSON objects with the following properties:
| Name | Type | Description |
|---|---|---|
product | string | |
line_of_business | string | |
tax_rate | number | |
status | string | |
customer | Object | |
broker_company | Object | |
person_in_charge | Object |
Tender Status
The tender statuses are as below:
| Status | Description |
|---|---|
| QUOTES_AVAILABLE | Tender has started and offers are generated shared with the customer. |
| IN_NEGOTIATION | Broker has started negotiation with Insurer. |
| IN_COVERNOTE | Broker has requested order to cover. |
| SUCCESSFUL | Tender has been successful and contract is created. |
| CLOSED | Tender has been unsuccessful. |
| REOPENED | Tender has been re-opened. |
Tender Customer Details
The customer property contains the name and address of the customer who is the subject of the tender request. Broker has created the tender request on behalf of the specified customer.
Tender Product and Line of business
Property product has the name of the insurance product that broker is requesting the tender. Each product belongs to a certain line of business (e.g. Cyber, D&O) which is accessible via line_of_business property.
Tender Broker and Person in charge
Every tender has a broker_company and person_in_charge. The broker company is the actual broker who on behalf of the customer is requesting insurers. For most cases, the broker is request the customer to fill in the risk assessment but in some cases, broker decides to fill in the questionnaire on behalf of customer.
The person in charge is the user who created a tender request. By default, the person in charge of a tender request is the submitter submitter of the request when interacting with Finlex Platform.
{
"_id": "63dd2f6134fb03000831b475",
"changes_metadata": {
"status_changed_to_quotes_available": "2023-02-03T16:00:53.972Z"
},
"created_at": "2023-02-03T15:59:29.208Z",
"product": "Special D&O Product",
"status": "QUOTES_AVAILABLE",
"tax_rate": 0.19,
"updated_at": "2023-02-03T16:00:53.990Z",
"line_of_business": {
"_id": "8qjpJ2RE6AHhMiksB",
"name": "Cyber Versicherung"
},
"customer": {
"_id": "63da8d4466d10900066b26af",
"address": {
"street": "",
"house_number": "",
"zip": "zg",
"city": "",
"country": "DE"
},
"company_id": "63da8d4466d10900066b26af",
"name": "Ms test test"
},
"broker_company": {
"_id": "COMiDryfjsB8A",
"address": {
"street": "C Isaac Albeniz 9 4 28 - La Pineda",
"house_number": "/",
"zip": "23455",
"city": "Vila-seca",
"country": "DE"
},
"company_id": "COMiDryfjsB8A",
"email": "[email protected]",
"name": "Broker Q"
},
"person_in_charge": {
"_id": "ACCjIBsnvffox",
"account_id": "ACCjIBsnvffox",
"email": "[email protected]",
"first_name": "Broker",
"last_name": "Q1",
"salutation": "Mrs"
}
}
Updated over 1 year ago