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 | |
|
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:xJeuH9",
"offer_uprn": "",
"force_new": 1,
"customer_post_code": "BD18 1DZ",
"home_begindate": "",
"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": 25,
"home_contents_distributor_commission": 25,
"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:xJeuH9",
"declined": false,
"is_new": true,
"offer_oid": "13168949",
"offer_no": "OCC000620485A",
"date_start": "2026-02-04",
"policy_excess": null,
"buildings_policy_excess": "100",
"contents_policy_excess": "200",
"single_article_limit": "2000",
"no_claims": "0",
"premiums": {
"extensions": {
"total": {
"annual": {
"buildings": {
"ad": 30.97,
"home_emergency": 39.99,
"personal_possessions": 0,
"legal_protection": 24.49
},
"contents": {
"ad": 36.35,
"home_emergency": 39.99,
"personal_possessions": 111.04,
"legal_protection": 24.49
},
"combined": {
"ad": 65.5,
"home_emergency": 39.99,
"personal_possessions": 105.27,
"legal_protection": 24.49
}
},
"monthly": {
"buildings": {
"ad": 2.82,
"home_emergency": 3.63,
"personal_possessions": 0,
"legal_protection": 2.23
},
"contents": {
"ad": 3.31,
"home_emergency": 3.63,
"personal_possessions": 10.11,
"legal_protection": 2.23
},
"combined": {
"ad": 5.96,
"home_emergency": 3.63,
"personal_possessions": 9.58,
"legal_protection": 2.23
}
}
},
"gross": {
"annual": {
"buildings": {
"ad": 27.27,
"home_emergency": 35.21,
"personal_possessions": 0,
"legal_protection": 21.56
},
"contents": {
"ad": 32.01,
"home_emergency": 35.21,
"personal_possessions": 97.78,
"legal_protection": 21.56
},
"combined": {
"ad": 57.68,
"home_emergency": 35.21,
"personal_possessions": 92.7,
"legal_protection": 21.56
}
},
"monthly": {
"buildings": {
"ad": 2.48,
"home_emergency": 3.2,
"personal_possessions": 0,
"legal_protection": 1.96
},
"contents": {
"ad": 2.91,
"home_emergency": 3.2,
"personal_possessions": 8.9,
"legal_protection": 1.96
},
"combined": {
"ad": 5.25,
"home_emergency": 3.2,
"personal_possessions": 8.44,
"legal_protection": 1.96
}
}
},
"ipt": {
"annual": {
"buildings": {
"ad": 3.27,
"home_emergency": 4.23,
"personal_possessions": 0,
"legal_protection": 2.59
},
"contents": {
"ad": 3.84,
"home_emergency": 4.23,
"personal_possessions": 11.73,
"legal_protection": 2.59
},
"combined": {
"ad": 6.92,
"home_emergency": 4.23,
"personal_possessions": 11.12,
"legal_protection": 2.59
}
},
"monthly": {
"buildings": {
"ad": 0.3,
"home_emergency": 0.38,
"personal_possessions": 0,
"legal_protection": 0.24
},
"contents": {
"ad": 0.35,
"home_emergency": 0.38,
"personal_possessions": 1.07,
"legal_protection": 0.24
},
"combined": {
"ad": 0.63,
"home_emergency": 0.38,
"personal_possessions": 1.01,
"legal_protection": 0.24
}
}
},
"net_to_distributor": {
"annual": {
"buildings": {
"ad": 21.82,
"home_emergency": null,
"personal_possessions": 0,
"legal_protection": null
},
"contents": {
"ad": 25.61,
"home_emergency": null,
"personal_possessions": 78.22,
"legal_protection": null
},
"combined": {
"ad": 46.14,
"home_emergency": null,
"personal_possessions": 74.16,
"legal_protection": null
}
}
}
},
"core": {
"total": {
"annual": {
"buildingsValue": 241.33,
"contentsValue": 241.33,
"combinedValue": 312.95
},
"monthly": {
"buildingsValue": 76.16,
"contentsValue": 76.16,
"combinedValue": 82.68
}
},
"gross": {
"annual": {
"buildingsValue": 160,
"contentsValue": 160,
"combinedValue": 223.06
},
"monthly": {
"buildingsValue": 14.56,
"contentsValue": 14.56,
"combinedValue": 20.3
}
},
"ipt": {
"annual": {
"buildingsValue": 19.2,
"contentsValue": 19.2,
"combinedValue": 26.77
},
"monthly": {
"buildingsValue": 1.75,
"contentsValue": 1.75,
"combinedValue": 2.44
}
},
"net_to_distributor": {
"annual": {
"buildingsValue": 128,
"contentsValue": 128,
"combinedValue": 178.45
},
"monthly": {
"buildingsValue": 11.65,
"contentsValue": 11.65,
"combinedValue": 16.24
}
}
}
},
"status": "1",
"stripe_fee": 0,
"stripe_percent": 0,
"ipt_percent": 12,
"uprn": 100051286209,
"udprn": null,
"umrrn": null,
"broker_fee": 40,
"experian_fee": 18.6,
"fulfill_policy": null,
"home_buildings_distributor_commission": "25",
"home_contents_distributor_commission": "25",
"home_combined_distributor_commission": "25",
"hash": "eyJpdiI6IlU4akpPeUh4T05jYkFxcVVBcEtYcVE9PSIsInZhbHVlIjoiKzBxVDVuRTZuSktpNnM1VDV2VWpjdz09IiwibWFjIjoiY2M2NDU3ZjE5YWExMzI5NjEzOGFmOWVhZjVhYjdkNzUwN2I1ZmViMmNkZTA2MjY0NmM2MjgyMzk3MzFkMTE3MiJ9",
"url": ""
},
"apirequest_oid": "13168948"
}