Create or retrieve an offer.
Enter OFFER OID to retrieve an existing offer.
|
API token
|
|
|
output
|
|
Force new | |
|
Full Address
|
|
|
uprn
|
|
|
udprn
|
|
|
umrrn
|
|
|
Address ID (AddressCloud)
|
|
|
First name
|
|
|
Last name
|
|
E-mail address | |
Policy Start Date | |
|
Policy Excess
|
|
|
Buildings Policy Excess
|
|
|
Contents Policy Excess
|
|
|
Single Article Limit
|
|
|
Single Article Limit Personal Possessions
|
|
|
Number of claims in last 5 years
|
|
|
Buildings Distributor commission
|
%
|
|
Contents Distributor commission
|
%
|
|
Combined Distributor commission
|
%
|
Fulfill policy | |
|
offer oid
|
|
|
Renewal policy oid
|
|
| Parameter | Type | Reqd | Description | Options |
|---|---|---|---|---|
| address_id | string | Address ID (AddressCloud) | ||
| force_new | classifier | Force new | 0 -- No 1 -- Yes | |
| customer_name_first | string | First name | ||
| customer_name_last | string | Last name | ||
| customer_post_code | string | Post Code | ||
| customer_address | string | Full Address | ||
| home_begindate | date | Policy Start Date | ||
| home_policy_excess | classifier | Policy Excess | 100 -- 0 150 -- 50 200 -- 100 250 -- 150 300 -- 200 350 -- 250 400 -- 300 | |
| home_buildings_policy_excess | classifier | Buildings Policy Excess | 100 -- 0 150 -- 50 200 -- 100 250 -- 150 300 -- 200 350 -- 250 400 -- 300 | |
| home_contents_policy_excess | classifier | Contents Policy Excess | 100 -- 0 150 -- 50 200 -- 100 250 -- 150 300 -- 200 350 -- 250 400 -- 300 | |
| home_single_article_limit | classifier | Single Article Limit | 2000 -- 2000 3000 -- 3000 4000 -- 4000 5000 -- 5000 6000 -- 6000 7000 -- 7000 8000 -- 8000 9000 -- 9000 10000 -- 10000 | |
| home_personal_possessions_single_article_limit | classifier | Single Article Limit Personal Possessions | 2000 -- 2000 3000 -- 3000 4000 -- 4000 5000 -- 5000 6000 -- 6000 7000 -- 7000 8000 -- 8000 9000 -- 9000 10000 -- 10000 | |
| home_no_claims | string | Number of claims in last 5 years | ||
| offer_uprn | string | UPRN | ||
| offer_udprn | string | UDPRN | ||
| offer_umrrn | string | UMRRN | ||
| home_buildings_distributor_commission | numeric | Buildings Distributor commission | ||
| home_contents_distributor_commission | numeric | Contents Distributor commission | ||
| home_combined_distributor_commission | numeric | Combined Distributor commission | ||
| fulfill_policy | classifier | Fulfill policy | 0 -- No 1 -- Yes | |
| offer_oid | string | offer oid | ||
| return_data | classifier | Return data? | 0 -- No 1 -- Yes | |
| calculation_only | classifier | Set true to return only calculation without creating a real quote | 0 -- No 1 -- Yes | |
| policy_oid | string | Renewal policy oid |
| Parameter | Type | Description |
|---|---|---|
| status | integer | Status |
| response | array | Offer properties |
| response.is_new | bool | Is the offer new or existing |
| response.offer_oid | string | Offer OID |
| response.offer_no | string | Offer number |
| response.premiums | array | list of premiums |
| response.status | integer | Status |
| response.data | string | Landmark attributes |
| response.is_renewal | bool | Is the offer renewal or not |
| response.renewal_policy_oid | string | OID of the renewal policy |
Json request example
{
"ajax_url": "/api/offer/getoffer",
"address_id": "8e1942cc0c8e76f:MAcxRl",
"offer_uprn": "",
"force_new": 1,
"customer_post_code": "BD18 1DZ",
"home_begindate": "",
"home_policy_excess": 200,
"home_buildings_policy_excess": 100,
"home_contents_policy_excess": 200,
"home_single_article_limit": 2000,
"home_no_claims": 0,
"customer_address": "248 Leeds Road, Shipley BD18 1DZ",
"home_buildings_distributor_commission": 15,
"home_contents_distributor_commission": 20,
"home_combined_distributor_commission": 25,
"offer_oid": null,
"offer_oid_hash": null
}
Json response example
{
"status": "1",
"declined": false,
"response": {
"postcode": "BD18 1DZ",
"address_id": "8e1942cc0c8e76f:MAcxRl",
"declined": false,
"is_new": true,
"offer_oid": "10985296",
"offer_no": "OCC072933A",
"date_start": "2022-12-21",
"policy_excess": "200",
"buildings_policy_excess": "100",
"contents_policy_excess": "200",
"single_article_limit": "2000",
"no_claims": "0",
"premiums": {
"extensions": {
"total": {
"annual": {
"buildings": {
"ad": 23.7,
"home_emergency": 39.99,
"personal_possessions": 0,
"legal_protection": 24.49
},
"contents": {
"ad": 27.81,
"home_emergency": 39.99,
"personal_possessions": 101.55,
"legal_protection": 24.49
},
"combined": {
"ad": 56.8,
"home_emergency": 39.99,
"personal_possessions": 106.92,
"legal_protection": 24.49
}
},
"monthly": {
"buildings": {
"ad": 2.16,
"home_emergency": 3.63,
"personal_possessions": 0,
"legal_protection": 2.23
},
"contents": {
"ad": 2.54,
"home_emergency": 3.63,
"personal_possessions": 9.25,
"legal_protection": 2.23
},
"combined": {
"ad": 5.17,
"home_emergency": 3.63,
"personal_possessions": 9.73,
"legal_protection": 2.23
}
}
},
"gross": {
"annual": {
"buildings": {
"ad": 20.87,
"home_emergency": 35.21,
"personal_possessions": 0,
"legal_protection": 21.56
},
"contents": {
"ad": 24.49,
"home_emergency": 35.21,
"personal_possessions": 89.42,
"legal_protection": 21.56
},
"combined": {
"ad": 50.02,
"home_emergency": 35.21,
"personal_possessions": 94.14,
"legal_protection": 21.56
}
},
"monthly": {
"buildings": {
"ad": 1.9,
"home_emergency": 3.2,
"personal_possessions": 0,
"legal_protection": 1.96
},
"contents": {
"ad": 2.23,
"home_emergency": 3.2,
"personal_possessions": 8.14,
"legal_protection": 1.96
},
"combined": {
"ad": 4.55,
"home_emergency": 3.2,
"personal_possessions": 8.57,
"legal_protection": 1.96
}
}
},
"ipt": {
"annual": {
"buildings": {
"ad": 2.5,
"home_emergency": 4.23,
"personal_possessions": 0,
"legal_protection": 2.59
},
"contents": {
"ad": 2.94,
"home_emergency": 4.23,
"personal_possessions": 10.73,
"legal_protection": 2.59
},
"combined": {
"ad": 6,
"home_emergency": 4.23,
"personal_possessions": 11.3,
"legal_protection": 2.59
}
},
"monthly": {
"buildings": {
"ad": 0.23,
"home_emergency": 0.38,
"personal_possessions": 0,
"legal_protection": 0.24
},
"contents": {
"ad": 0.27,
"home_emergency": 0.38,
"personal_possessions": 0.98,
"legal_protection": 0.24
},
"combined": {
"ad": 0.55,
"home_emergency": 0.38,
"personal_possessions": 1.03,
"legal_protection": 0.24
}
}
}
},
"core": {
"total": {
"annual": {
"buildingsValue": 169.54,
"contentsValue": 159.85,
"combinedValue": 313.62
},
"monthly": {
"buildingsValue": 60.4,
"contentsValue": 59.52,
"combinedValue": 73.51
}
},
"gross": {
"annual": {
"buildingsValue": 105.71,
"contentsValue": 97.19,
"combinedValue": 232.58
},
"monthly": {
"buildingsValue": 9.62,
"contentsValue": 8.84,
"combinedValue": 21.16
}
},
"ipt": {
"annual": {
"buildingsValue": 12.69,
"contentsValue": 11.66,
"combinedValue": 27.91
},
"monthly": {
"buildingsValue": 1.15,
"contentsValue": 1.06,
"combinedValue": 2.54
}
}
}
},
"status": "1",
"stripe_fee": 0.2,
"stripe_percent": 1.4,
"ipt_percent": 12,
"uprn": 100051286209,
"broker_fee": 30,
"experian_fee": 18.6,
"hash": "eyJpdiI6ImMzYjM2TlRndWduYzBBRklDdlU4dXc9PSIsInZhbHVlIjoiaVhQS0NSa1UrR3h2WEYwdnMra2xDdz09IiwibWFjIjoiMzUxYWM5YWFiNTRjM2VjZDFmNGJlOGU0ZTg4MGZiZGJhZjBiYWZjMGZjMGFiNjM1Y2UzYzJlYWRmMDE4Zjc5ZiJ9",
"url": ""
},
"apirequest_oid": "10985295"
}