Insurer Covernote API
Overview
Insurer is able to get list of requested order to covers and finalize the tender by accepting or declining the request.
List Cover Requests
curl https://{environment}/api/v1/covernotes \
-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"
}
}]
}
Accept Requests
Accepts the order to cover requests and sets the tender to SUCCESSFUL
state.
GET https://{environment}/public/v1/covernotes/:covernote_id/accept
Decline Requests
Accepts the order to cover requests and sets the tender to SUCCESSFUL
state.
GET https://{environment}/public/v1/covernotes/:covernote_id/decline
JSON Format
Covernotes 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 | |
insurer_company | Object | |
underwriter | Object | |
premium | number | |
insurance_sum | number | |
broker_commission | number | |
start_date | DateTime | |
end_date | DateTime | |
currency | string | |
deductible | number | |
period_begin_at | DateTime | |
period_end_at | DateTime | |
period_premium | number | |
tax_rate | number | |
wording | string |
Covernote Status
The covernote statuses are as below:
Status | Description |
---|---|
OPEN | Broker has requested order to cover. |
SUCCESSFUL | Request has been successful and contract is created. |
DECLINED | Request has been declined by underwriter. |
CANCELLED | Request has been cancelled by broker. |
REOPENED | Request has been re-opened. |
Updated almost 2 years ago