The API uses HTTP basic authentication. Provide your username as the username and your password as the password.
Not supplying the header will result in a 401 Unauthorized.
{ "Message": "Authorization has been denied for this request." }
The API uses a custom header to secure specific broker related content.
The value for the header is a Base64 encoded string, the plain text of which is brokerId:password
"12345:myPassword"
Not supplying the header when requested will result in a 401 Broker Not Authorized.
{ "Message": "Broker Not Authorized" }
All list/index endpoints are ordered and paginated reverse chronologically by default.
LengthUpper bound for the number of objects to be returned. Defaults to 50. Maximum of 100.
OffsetThe number of resources to skip.
Paginated results are always returned in an array, and include the following meta data:
TotalTotal number of resources available with the query.
OffsetThe number of resources to skip.
LengthThe size of the resource set to return.
CurrentPageThe page of results that has been returned.
PageCountThe total number of pages available.
ResourceThe array of resources asked for.
GET https://api.thesource.co.uk/api/commissionrecords HTTP/1.1
HTTP/1.1 200 (OK)
{
"Meta": {
"Total": 67,
"Offset": 0,
"Length": 50,
"CurrentPage": 1,
"PageCount": 2
},
"Resource": [{
...
}]
}
The following example will allow you to return the next 100 records while skipping the first 2000 records. This will allow you to get records 2000-2100. You can see that you are on page 21 and that there is 114 pages in total.
GET https://api.thesource.co.uk/api/commissionrecords?length=100&offset=2000 HTTP/1.1
HTTP/1.1 200 (OK)
{
"Meta": {
"Total": 11315,
"Offset": 2000,
"Length": 100,
"CurrentPage": 21,
"PageCount": 114
},
"Resource": [{
...
}]
}
The API uses rate limiting to limit the number of requests to the API per authenticated user.
When the rate limit is breached you will receive a 429 status code and a message explaining what limit was breached and when you can re-access the resource.
"API rate limit exceeded, maximum admitted 60 per Minute. Retry in 22s"
In addition you will receive a Retry-After header that will inform you when you may access the resource again.
All timestamps are formatted as ISO8601 with timezone information. For API calls that allow for a timestamp to be specified, we use that exact timestamp. These timestamps look something like 2014-02-27T15:05:06Z.
GET https://api.thesource.co.uk/api/CommissionRecords?paymentDateMax=2014-02-27T15:05:06Z HTTP/1.1
The first line of code creates your authentication credentials using your username and password.
The using statement creates an HttpClient instance and disposes it when the instance goes out of scope.
This code sets the base URI for HTTP requests, sets the Accept header to "application/json", which tells the server to send data in JSON format, and sets the Basic authentication header using the credentials we created above.
var credentials = Convert.ToBase64String(ASCIIEncoding.ASCII.GetBytes(string.Format("{0}:{1}", "username", "password")));
using (var client = new HttpClient())
{
client.BaseAddress = new Uri("https://api.thesource.co.uk/");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
// Requests...
}This code example sends a GET request for a specific broker
The API endpoint for this example is Brokers
The GetAsync method sends the HTTP GET request. The method is asynchronous, because it performs network I/O. The await keyword suspends execution until the asynchronous method completes. When the method completes, it returns an HttpResponseMessage that contains the HTTP response.
If the status code in the response is a success code, the response body contains the JSON representation of a broker. Call ReadAsAsync to deserialize the JSON payload to a Broker instance. The Read method is asynchronous because the response body can be arbitrarily large.
// GET:
using (HttpResponseMessage response = await client.GetAsync("api/brokers/12345"))
{
if (response.IsSuccessStatusCode)
{
Broker broker = await response.Content.ReadAsAsync<Broker>();
Console.WriteLine("{0} - {1} - {2}", broker.id, broker.CompanyName, broker.AuthorisedToQuote);
}
else if (response.StatusCode == System.Net.HttpStatusCode.NotFound)
Console.WriteLine("Resource Not Found");
else
Console.WriteLine("Http Status Code: " + response.StatusCode.ToString());
}
This code example sends a POST request that contains a Broker instance in JSON format
The PostAsJsonAsync method serializes an object to JSON and then sends the JSON payload in a POST request. To send XML, use the PostAsXmlAsync method. To use another formatter, call PostAsync:
// HTTP POST
var myBroker = new Broker() { CompanyName = "Test Broker Corporation", AuthorisedToQuote = true };
using (var response = await client.PostAsJsonAsync("api/brokers", myBroker))
if (response.IsSuccessStatusCode)
{
//The URL of the newly created resource
Uri brokerUrl = response.Headers.Location;
}
The curl_init method initalizes a new cURL session.
Options are the passed to the cURL session using the curl_setopt method.
This code sets the RETURNTRANSFER option to true, which tells cURL to return the transfer as a string instead of outputting it directly. The USERPWD option allows us to set the username and password to use for connection, and the HTTPAUTH option allows us to set the authentication mechanism to Basic
$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "username" . ":" . "password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);This code example sends a GET request for a specific broker
The API endpoint for this example is Brokers
Using the CURLOPT_URL option we can set the URL to get Broker with the id 12345
The cURL is the executed and the response is stored in a variable. The Http Status code is then retrieved and the cURL session is closed.
If the status code is 200 the response can be decoded into a JSON object using the json_decode method, and variables can be accessed from the array by name. If the status code is 404 we know that the resource we tried to get does not exists.
// GET:
curl_setopt($ch, CURLOPT_URL, "https://api.thesource.co.uk/api/brokers/58252");
$response = curl_exec($ch);
$httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if($httpcode == 200){
$response_json = json_decode($response);
echo "Broker: " . $response_json->{'id'} . " - " . $response_json->{'CompanyName'} . " - " . $response_json->{'AuthorisedToQuote'};
}
else if($httpcode == 404){
echo "Resource Not Found";
}
else{
echo "Http Status Code: " . $httpcode;
}
TODO:
// HTTP POST
TODO:
* Required field
Lookup classes hold details for input lists on Source systems.
The API allows you to view and list lookup classes.
Returns a paginated list of lookup class names
Relative endpoint: GET /lookups
You must supply a X-Broker-Authentication header with the broker's username and password.
GET https://api.thesource.co.uk/api/lookups HTTP/1.1
HTTP/1.1 200 (OK)
{
"Meta": {
"Total": 42,
"Offset": 0,
"Length": 5000,
"CurrentPage": 1,
"PageCount": 1
},
"Resource": [
"BusinessTypeOfUse",
"BusinessTypeOfWork",
"ClaimCategories",
"ClaimDescriptions",
"ClaimSettledStatus",
"ConstructionRenovationImpact",
"ConstructionRenovationNatures",
"ConstructionRenovationPlanningPermission",
"ConvictionPersonHH",
"ConvictionPersonLP",
"ConvictionSentences",
"ConvictionTypes",
"Documents",
"FlatFloorNumbers",
"FlatRoofPercent",
"HighRiskItems",
"HighRiskItemsInsurableAwayFromHome",
"ListedBuildingGrades",
"LockTypes",
"NatureOfBusiness",
"OccupancyTypesHH",
"OccupancyTypesLP",
"OccupantTypes",
"Occupations",
"OwnershipStatusHH",
"OwnershipStatusLP",
"PaymentMethods",
"PropertyOwnersLiabilitySumInsured",
"PropertyTypesHH",
"PropertyTypesLP",
"ResidenceTypes",
"RoofTypes",
"SpecialTermReasons",
"TenantTypes",
"Titles",
"UnoccupiedConsecutiveDays",
"UnoccupiedCoverLevels",
"UnoccupiedReasonsHH",
"UnoccupiedReasonsLP",
"VoluntaryExcess",
"WallTypes",
"YesNoIndicator"
]
}
Relative endpoint: GET /lookups/PropertyTypesHH
You must supply a X-Broker-Authentication header with the broker's username and password.
namename of the lookup class.
GET https://api.thesource.co.uk/api/lookups/PropertyTypesHH HTTP/1.1
HTTP/1.1 200 (OK)
{
"Meta": {
"Total": 20,
"Offset": 0,
"Length": 50,
"CurrentPage": 1,
"PageCount": 1
},
"Resource": [
"Detached House",
"Semi-Detached House",
"Detached Bungalow",
"Semi-Detached Bungalow",
"End Town House",
"Mid Town House",
"Detached Town House",
"Maisonette",
"Studio",
"Flat above Commercial Premises",
"Mid-Terraced House",
"End Terraced House",
"Mid-Terraced Bungalow",
"End Terraced Bungalow",
"Purpose Built Flat",
"Converted Flat",
"Converted Barn",
"Coach House",
"Church Conversion",
"Bedsit"
]
}
Quote objects hold the results of insurance quotes
QuoteResultId[string]Id of the individual QuoteResult.
RiskId[string]Id of the Quote/Risk record containing the QuoteResults.
AnnualPremium[decimal]The total price of the insurance, extras and fees.
MonthlyPremium[string]The monthly price if paying by Direct Debit, including a charge for credit.
ProviderName[string]The insurance provider.
ProductName[string]The insurance product.
ProductCode[string]The Source product code.
ExpiresAt[datetime]Date quote guarantee expires.
InceptionDate[datetime]Date the chosen cover starts.
Declined[boolean]Indicates if the product has declined to quote for the supplied risk.
Referred[boolean]Indicates if the product has offered a premium subject to referral.
BrokerCommissionRate[decimal]The broker commission rate used on the quote.
IPTRate[decimal]The Insurance Premium Tax rate used.
EndorsementCodes[string]A comma-separated list of endorsements that apply to the quote.
DeclineReasonsText[string]The reasons for the quote being declined by the insurer.
AdjustmentsText[string]Any automatic adjustments made by the insurer.
AdditionalInfoText[string]Any additional information supplied with the quote.
ReferralText[string]The reasons for the quote being referred by the insurer.
ConditionsText[string]Any conditions attached to the quote.
CreditRate[decimal]The credit percentage charged for paying monthly by Direct Debit.
CreditAPR[decimal]The annual credit percentage rate on Direct Debit loans.
FinanceCharge[decimal]The charge for credit on non interest bearing Direct Debit loans.
PaymentHolidayMonthsPre[integer]The number of months before regular Direct Debit payments are taken.
PaymentMonths[integer]The number of regular Direct Debit monthly payments.
PaymentHolidayMonthsPost[integer]The number of months after all regular Direct Debit payments are taken before completion of the loan.
InterestAmount[decimal]The total amount of interest for the Direct Debit loan.
FrontLoaded[boolean]Indicates whether the total credit charge on a Direct Debit loan is taken with the first payment.
FrontLoadAmount[decimal]The total amount added to the first regular payment.
BackLoaded[boolean]Indicates whether the total credit charge on a Direct Debit loan is taken with the last payment.
BackLoadAmount[decimal]The total amount added to the last regular payment.
FailedPaymentCharge[decimal]Amount charged if any payment cannot be collected.
HouseholdThe Household insurance specific result data. Will be null if the QuoteResult is not for household insurance.
LetPropertiesThe Let Property insurance specific result data. Will be null if the QuoteResult is not for let property insurance.
ASUThe ASU insurance specific result data. Will be null if the QuoteResult is not for ASU insurance.
Household objects hold the insurance product specific data of quotes.
BuildingsSumInsured[decimal]The buildings sum insured or limit.
BuildingsAD[boolean]Indicates if buildings accidental damage cover is included.
NCDBuildings[integer]The buildings no claims discount granted.
BuildingsExcessTotal[decimal]The buildings total excess to be paid in the event of a claim.
BuildingsExcessCompulsory[decimal]The compulsory portion of buildings total excess.
BuildingsExcessVoluntary[decimal]The voluntary portion of buildings total excess.
SubsidenceExcess[decimal]The excess to be paid in the event of a subsidence claim.
BuildingsNotional[boolean]Indicates if the buildings premium was calculated on a notional (bedroom-rated) basis.
BuildingsNotionalLimit[decimal]The buildings sum insured limit provided on a notional quote.
BuildingsSumInsuredInput[decimal]The buildings sum insured used to produce the quote.
ContentsSumInsured[decimal]The contents sum insured or limit.
ContentsAD[boolean]Indicates if contents accidental damage cover is included.
NCDContents[integer]The contents no claims discount granted.
ContentsExcessTotal[decimal]The contents total excess to be paid in the event of a claim.
ContentsExcessCompulsory[decimal]The compulsory portion of contents total excess.
ContentsExcessVoluntary[decimal]The voluntary portion of contents total excess.
ContentsValuablesSumInsured[decimal]The contents valuables sum insured.
ContentsNotional[boolean]Indicates if the contents premium was calculated on a notional (bedroom-rated) basis.
ContentsNotionalLimit[decimal]The contents sum insured limit provided on a notional quote.
ContentsSumInsuredInput[decimal]The contents sum insured used to produce the quote.
PossessionsUnspecifiedSI[decimal]The unspecified possessions sum insured.
PossessionsSpecifiedSI[decimal]The specified possessions sum insured.
PossessionsExcessTotal[decimal]The possessions total excess to be paid in the event of a claim.
PossessionsExcessCompulsory[decimal]The compulsory portion of possessions total excess.
PossessionsExcessVoluntary[decimal]The voluntary portion of possessions total excess.
PossessionsMoney[decimal]The money sum insured under the possessions section.
PossessionsCreditCards[decimal]The credit cards sum insured under the possessions section.
PossessionsCyclesSI[decimal]The pedal cycles sum insured under the possessions section.
SourceLegalCover[boolean]Indicates if Source legal cover is included (always true).
SourceHomeEmergencyCover[boolean]Indicates if Source home emergency cover is included.
GardenCover[boolean]Indicates if garden cover is included.
TraceAndAccess[string]The sum insured or limit for trace and access.
PersonalLiabilityLimit[string]The sum insured or limit for personal liability.
BusinessEquipLimit[string]The sum insured or limit for business equipment.
OutbuildingsLimit[string]The sum insured or limit for outbuildings.
PossessionsSingleArticleLimit[string]The single article limit under the possessions cover section.
BuildingsUnoccupancyDays[string]The maximum number of days the property can be unoccupied for the buildings cover.
ContentsUnoccupancyDays[string]The maximum number of days the property can be unoccupied for the contents cover.
TheftFromVehicle[string]The sum insured or limit for theft from a vehicle.
BuildingsExtendedADExcess[string]The excess (or additional excess) to be paid in the event of a claim for accidental damage under the buildings section. Please consult your policy schedule.
BuildingsEscapeOfWaterExcess[string]The excess (or additional excess) to be paid in the event of a claim for escape of water under the buildings section. Please consult your policy schedule.
ContentsExtendedADExcess[string]The excess (or additional excess) to be paid in the event of a claim for accidental damage under the contents section. Please consult your policy schedule.
ContentsEscapeOfWaterExcess[string]The excess (or additional excess) to be paid in the event of a claim for escape of water under the contents section. Please consult your policy schedule.
ValuablesSingleItemLimit[string]The single item limit for valuables insured under the contents cover section.
FreezerFood[string]The sum insured or limit for freezer food.
BuildingsAltAccomLimit[string]The sum insured or limit for alternative accommodation required as the result of a buildings claim.
ContentsAltAccomLimit[string]The sum insured or limit for alternative accommodation required as the result of a contents claim.
ValuablesLimit[string]The total cover limit for valuables covered under the contents section.
ContentsTempRemoved[string]The sum insured or limit for content temporarily removed from the property.
LockReplacementCover[string]The sum insured or limit for lock replacement.
PossessionsTotalLimit[string]The total cover limit for possessions.
SourceHECLimit[string]The sum insured or limit for Source home emergency cover.
LetProperty objects hold the insurance product specific data of quotes.
BuildingsSumInsured[decimal]The buildings sum insured or limit.
BuildingsAD[boolean]Indicates if buildings accidental damage cover is included.
NCDBuildings[integer]The buildings no claims discount granted.
BuildingsExcessTotal[decimal]The buildings total excess to be paid in the event of a claim.
BuildingsExcessCompulsory[decimal]The compulsory portion of buildings total excess.
BuildingsExcessVoluntary[decimal]The voluntary portion of buildings total excess.
SubsidenceExcess[decimal]The excess to be paid in the event of a subsidence claim.
BuildingsNotional[boolean]Indicates if the buildings premium was calculated on a notional (bedroom-rated) basis.
BuildingsNotionalLimit[decimal]The buildings sum insured limit provided on a notional quote.
BuildingsSumInsuredInput[decimal]The buildings sum insured used to produce the quote.
ContentsSumInsured[decimal]The contents sum insured or limit.
ContentsAD[boolean]Indicates if contents accidental damage cover is included.
NCDContents[integer]The contents no claims discount granted.
ContentsExcessTotal[decimal]The contents total excess to be paid in the event of a claim.
ContentsExcessCompulsory[decimal]The compulsory portion of contents total excess.
ContentsExcessVoluntary[decimal]The voluntary portion of contents total excess.
ContentsNotional[bool]Indicates if the contents premium was calculated on a notional (bedroom-rated) basis.
ContentsNotionalLimit[decimal]The contents sum insured limit provided on a notional quote.
ContentsSumInsuredInput[decimal]The contents sum insured used to produce the quote.
SourceLegalCover[boolean]Indicates if Source legal cover is included (always true).
SourceRentCover[boolean]Indicates if Source rent guarantee cover is included.
SourceHomeEmergencyCover[boolean]Indicates if Source home emergency cover is included.
LossOfRentCover[boolean]Indicates if loss of rent cover is included.
PropertyOwnersLiabilityCover[boolean]Indicates if property owners liability cover is included.
ContentsLiabilityCover[boolean]Indicates if contents liability cover is included.
MaliciousDamageCover[boolean]Indicates if malicious damage cover is included.
BuildingsTraceAndAccessCover[boolean]Indicates if buildings trace and access cover is included.
BuildingsEmployersLiabilityCover[boolean]Indicates if employers liability cover is included.
ContentsTheftCover[boolean]Indicates if contents theft cover is included.
RentCoverPeriodOfIndemnity[integer]The Source rent guarantee cover period of indemnity.
RentCoverMonthlySumInsured[decimal]The Source rent guarantee cover monthly rent sum insured.
LossOfRentSumInsured[decimal]The loss of rent sum insured or limit.
LossOfRentIndemnityPeriod[integer]The loss of rent period of indemnity.
PropertyOwnersLiabilitySumInsuredThe property owners liability sum insured or limit.
ContentsLiabilitySumInsuredThe contents liability sum insured or limit.
LandlordsLegalProtectionLimitThe landlords legal protection limit.
BuildingsEscapeOfWaterExcessThe excess (or additional excess) to be paid in the event of a claim for escape of water under the buildings section. Please consult your policy schedule.
ContentsEscapeOfWaterExcessThe excess (or additional excess) to be paid in the event of a claim for escape of water under the contents section. Please consult your policy schedule.
TraceAndAccessLimitThe trace and access sum insured or limit.
EmployersLiabilityLimitThe employers liability sum insured or limit.
TheftByTenantLimitThe theft by tenant sum insured or limit.
SourceHomeEmergencyCoverLimitThe sum insured or limit for Source home emergency cover.
ASU objects hold the insurance product specific data of quotes.
ProtectionTypeThe level of protection included e.g. Cover for income, rent or mortgage.
MonthlyCoverAmountThe monthly cover amount used to produce the quote.
PolicyExcessDaysASDays before claiming on Accident and Sickness.
PolicyExcessDaysUDays before claiming on Unemployment.
RisksCoveredRisks that are covered e.g. Unemployment and/or Accident & Sickness.
BenefitPeriodMonthsThis is the maximum number of monthly benefit payments payable for a single claim.
FractureCoverIndicates whether fracture beneft is included.
WaitingPeriodDaysMinimum number of days before making a claim, from the start date of the policy.
Relative endpoint: GET /quotes?id=5540d96741044a147cef8f24
You must supply a X-Broker-Authentication header with the broker's username and password.
idId of the saved Risk/Quote record containing a list of QuoteResults.
GET https://api.thesource.co.uk/api/quotes?id=5540d96741044a147cef8f24 HTTP/1.1
HTTP/1.1 200 (OK)
{
"Meta": {
"Total": 17,
"Offset": 0,
"Length": 50,
"CurrentPage": 1,
"PageCount": 1
},
"Resource": [
{
"QuoteResultId": "5540d96a41044a147cef8f25",
"RiskId": "5540d96741044a147cef8f24",
"ProviderName": "Sentinel",
"ProductName": "Extra",
"ProductCode": "sx",
"AnnualPremium": 262.35,
"MonthlyPremium": 24.27,
"Declined": false,
"Referred": false,
"DeclineReasonsText": "",
"AdjustmentsText": "Contents sum insured has been adjusted to the minimum amount of £50,000.",
"AdditionalInfoText": "Endorsement 0130 (Discounted security condition) applies.\ \ Endorsement 0063 (Security against theft) applies.\ \ Endorsement 0131 (Discounted alarm condition) applies.\ \ Endorsement 0041 (Burglar alarm) applies.\ \ Buildings Excess: £150\ \ Buildings Sum Insured: £150,000\ \ Buildings NCD: 2 year(s)\ \ Subsidence Excess: £1,000\ \ Contents Excess: £150\ \ Contents Sum Insured: £50,000\ \ Contents NCD: 2 year(s)\ \ Contents Valuables Sum Insured £0\ \ Unspecified Possessions Cover Not Selected\ \ Specified Possessions Cover Not Selected\ \ Pedal Cycles Cover Not Selected\ \ Money Not Selected\ \ Credit Cards Not Selected\ \ Garden cover included as standard\ \ Legal expenses cover included as standard\ \ * The insurer's engine was called requesting buildings cover using the sum insured supplied. \ \ * The insurer's engine was called requesting contents cover using the sum insured supplied. \ \ * It is your responsibility to provide an accurate rebuilding sum insured for the home to be covered by this policy. Please note that if you did not enter the rebuild cost yourself, Source bears no liability for the rebuilding cost estimate provided by BCIS. ",
"ReferralText": "",
"BrokerCommissionRate": 0,
"IPTRate": 0.06,
"EndorsementCodes": "0130,0063,0131,0041",
"CreditRate": 11,
"CreditAPR": 21.6,
"FinanceCharge": 0.00,
"PaymentHolidayMonthsPre": 0,
"PaymentMonths": 12,
"PaymentHolidayMonthsPost": 0,
"InterestAmount": 28.86,
"FrontLoaded": false,
"FrontLoadAmount": 0.00,
"BackLoaded": false,
"BackLoadAmount" 0.00,
"Household": {
"BuildingsSumInsured": 150000,
"BuildingsAD": true,
"NCDBuildings": 2,
"BuildingsExcessTotal": 150,
"BuildingsExcessCompulsory": 100,
"BuildingsExcessVoluntary": 0,
"SubsidenceExcess": 1000,
"BuildingsNotional": false,
"BuildingsNotionalLimit": 500000,
"BuildingsSumInsuredInput": 150000,
"ContentsSumInsured": 50000,
"ContentsAD": true,
"NCDContents": 2,
"ContentsExcessTotal": 150,
"ContentsExcessCompulsory": 100,
"ContentsExcessVoluntary": 0,
"ContentsValuablesSumInsured": 0,
"ContentsNotional": true,
"ContentsNotionalLimit": 50000,
"ContentsSumInsuredInput": 25000,
"PossessionsUnspecifiedSI": 0,
"PossessionsSpecifiedSI": 0,
"PossessionsExcessTotal": 0,
"PossessionsExcessCompulsory": 0,
"PossessionsExcessVoluntary": 0,
"PossessionsMoney": 0,
"PossessionsCreditCards": 0,
"PossessionsCycleSI": 0,
"SourceLegalCover": true,
"SourceHomeEmergencyCover": false,
"GardenCover": true,
"BuildingsPremium": 0,
"NetBuildingsPremium": 114.5,
"ContentsPremium": 0,
"NetContentsPremium": 74.37,
"PossessionsPremium": 0,
"NetPossessionsPremium": 0,
"OptionsPremium": 0,
"NetOptionsPremium": 0,
"TraceAndAccess": "5000",
"PersonalLiabilityLimit": "2000000",
"BusinessEquipLimit": "5000",
"OutbuildingsLimit": "2500",
"PossessionsSingleArticleLimit": "0",
"BuildingsUnoccupancyDays": "60 days",
"ContentsUnoccupancyDays": "60 days",
"TheftFromVehicle": "0",
"BuildingsExtendedADExcess": "150",
"BuildingsEscapeOfWaterExcess": "250",
"ContentsExtendedADExcess": "150",
"ValuablesSingleItemLimit": "2500",
"FreezerFood": "500",
"BuildingsAltAccomLimit": "30000",
"ContentsAltAccomLimit": "10000",
"ValuablesLimit": "15000",
"ContentsTempRemoved": "10000",
"LockReplacementCover": "750",
"PossessionsTotalLimit": "0",
"ContentsEscapeOfWaterExcess": "250",
"SourceHomeEmergencyCoverLimit": "0"
},
"LetProperty": null
},
{
"QuoteResultId": "5540d96a41044a147cef8f26",
"RiskId": "5540d96741044a147cef8f24",
"ProviderName": "Sentinel",
"ProductName": "Essentials",
"ProductCode": "se",
"AnnualPremium": 347.1,
"MonthlyPremium": 32.11,
"Declined": false,
"Referred": false,
"DeclineReasonsText": "",
"AdjustmentsText": "",
"AdditionalInfoText": "Endorsement 0130 (Discounted security condition) applies.\ \ Endorsement 0063 (Security against theft) applies.\ \ Endorsement 0131 (Discounted alarm condition) applies.\ \ Endorsement 0041 (Burglar alarm) applies.\ \ Buildings Excess: £150\ \ Buildings Sum Insured: £150,000\ \ Buildings NCD: 2 year(s)\ \ Subsidence Excess: £1,000\ \ Contents Excess: £150\ \ Contents Sum Insured: £25,000\ \ Contents NCD: 2 year(s)\ \ Contents Valuables Sum Insured £0\ \ Unspecified Possessions Cover Not Selected\ \ Specified Possessions Cover Not Selected\ \ Pedal Cycles Cover Not Selected\ \ Money Not Selected\ \ Credit Cards Not Selected\ \ Garden cover included as standard\ \ Legal expenses cover included as standard\ \ * The insurer's engine was called requesting buildings cover using the sum insured supplied. \ \ * The insurer's engine was called requesting contents cover using the sum insured supplied. \ \ * It is your responsibility to provide an accurate rebuilding sum insured for the home to be covered by this policy. Please note that if you did not enter the rebuild cost yourself, Source bears no liability for the rebuilding cost estimate provided by BCIS. ",
"ReferralText": "",
"BrokerCommissionRate": 0,
"IPTRate": 0.06,
"EndorsementCodes": "0130,0063,0131,0041",
"CreditRate": 11,
"CreditAPR": 21.6,
"FinanceCharge": 0.00,
"PaymentHolidayMonthsPre": 0,
"PaymentMonths": 12,
"PaymentHolidayMonthsPost": 0,
"InterestAmount": 38.18,
"FrontLoaded": false,
"FrontLoadAmount": 0.00,
"BackLoaded": false,
"BackLoadAmount" 0.00,
"Household": {
"BuildingsSumInsured": 150000,
"BuildingsAD": true,
"NCDBuildings": 2,
"BuildingsExcessTotal": 150,
"BuildingsExcessCompulsory": 150,
"BuildingsExcessVoluntary": 0,
"SubsidenceExcess": 1000,
"BuildingsNotional": false,
"BuildingsNotionalLimit": 0,
"BuildingsSumInsuredInput": 150000,
"ContentsSumInsured": 25000,
"ContentsAD": true,
"NCDContents": 2,
"ContentsExcessTotal": 150,
"ContentsExcessCompulsory": 150,
"ContentsExcessVoluntary": 0,
"ContentsValuablesSumInsured": 0,
"ContentsNotional": false,
"ContentsNotionalLimit": 0,
"ContentsSumInsuredInput": 25000,
"PossessionsUnspecifiedSI": 0,
"PossessionsSpecifiedSI": 0,
"PossessionsExcessTotal": 0,
"PossessionsExcessCompulsory": 0,
"PossessionsExcessVoluntary": 0,
"PossessionsMoney": 0,
"PossessionsCreditCards": 0,
"PossessionsCycleSI": 0,
"SourceLegalCover": true,
"SourceHomeEmergencyCover": false,
"GardenCover": false,
"BuildingsPremium": 0,
"NetBuildingsPremium": 141.17,
"ContentsPremium": 0,
"NetContentsPremium": 116.24,
"PossessionsPremium": 0,
"NetPossessionsPremium": 0,
"OptionsPremium": 0,
"NetOptionsPremium": 0,
"TraceAndAccess": "0",
"PersonalLiabilityLimit": "2000000",
"BusinessEquipLimit": "0",
"OutbuildingsLimit": "500",
"PossessionsSingleArticleLimit": "0",
"BuildingsUnoccupancyDays": "30 days",
"ContentsUnoccupancyDays": "30 days",
"TheftFromVehicle": "0",
"BuildingsExtendedADExcess": "150",
"BuildingsEscapeOfWaterExcess": "250",
"ContentsExtendedADExcess": "150",
"ValuablesSingleItemLimit": "1000",
"FreezerFood": "250",
"BuildingsAltAccomLimit": "22500",
"ContentsAltAccomLimit": "5000",
"ValuablesLimit": "5000",
"ContentsTempRemoved": "3750",
"LockReplacementCover": "250",
"PossessionsTotalLimit": "0",
"ContentsEscapeOfWaterExcess": "250",
"SourceHomeEmergencyCoverLimit": "0"
},
"LetProperty": null
},
{
"QuoteResultId": "5540d96a41044a147cef8f27",
"RiskId": "5540d96741044a147cef8f24",
"AnnualPremium": 462.39,
"MonthlyPremium": 42.77,
...
...
}
}
Relative endpoint: POST /quotes
You must supply a X-Broker-Authentication header with the broker's username and password.
N.B. Lookup: GET /lookups/(The name of the Lookups class from which permitted values must be taken)
*Delegated[boolean]Indicates if the call is delegated (i.e. to be retrieved later).
*QuickQuote[boolean]Indicates if this is for a Quote Quote (indicative only). If true then a minimal number of fields are required.
*Title1[string] (Max 50)The title of the first applicant.Lookup: GET /lookups/GET /lookups/Titles
*FirstName1[string] (Max 50)The first name of the first applicant.
*Surname1[string] (Max 50)The surname of the first applicant.
*DOB1[date]The date of birth of the first applicant.
*Occupation1[string] (Max 100)The occupation of the first applicant.Lookup: GET /lookups/Occupations
*NatureOfBusiness1[string] (Max 100)The nature of business of the first applicant.Lookup: GET /lookups/NatureOfBusiness
Email1[string] (Max 100)The email address of the first applicant
Title2[string] (Max 50)The title of the second applicant.Lookup: GET /lookups/Titles
FirstName2[string] (Max 50)The first name of the second applicant.
Surname2[string] (Max 50)The surname of the second applicant.
DOB2[date]The date of birth of the second applicant.
Occupation2[string] (Max 100)The occupation of the second applicant.Lookup: GET /lookups/Occupations
NatureOfBusiness2[string] (Max 100)The nature of business of the second applicant.Lookup: GET /lookups/NatureOfBusiness
Email2[string] (Max 100)The email address of the second applicant
*ElectronicDoc[boolean]Indicates if the client wants e-documents or to be sent in the post.
*CommissionRate[decimal]Indicates the level of commission for the policy.
*ProductType[string]The type of quote requested e.g. Household, BuyToLet or ASU.
CorrespondenceAddressDifferent[boolean]Indicates whether the correspondence address is different from the insured address.
CorrespondenceAddress1[string] (Max 50)The correspondence address line 1 of the applicant.
CorrespondenceAddress2[string] (Max 50)The correspondence address line 2 of the applicant.
CorrespondenceAddress3[string] (Max 50)The correspondence address line 3 of the applicant.
CorrespondenceAddress4[string] (Max 50)The correspondence address line 4 of the applicant.
CorrespondenceAddress5[string] (Max 50)The correspondence address line 5 of the applicant.
CorrespondencePostcode[string] (Max 8)The correspondence address post code of the applicant.
CorrespondenceAddressValidUntil[date]Indicates that the correspondence address is valid until the specified date.
CorrespondenceAddressInTheUK[boolean]Indicates whether the correspondence address is in the UK.
DaytimeTelephone[string] (Max 20)Daytime Telephone.
EveningTelephone[string] (Max 20)Evening Telephone.
HouseholdThe Household insurance specific risk data. Will be null if the Quote is not for household insurance.
LetPropertyThe Let Property insurance specific risk data. Will be null if the Quote is not for let property insurance.
ASUThe ASU insurance specific risk data. Will be null if the Quote is not for ASU insurance.
*InsuredPostcode[string] (Max 8)The postcode of the risk address.
*ProposerOwnershipStatus[string] (Max 50)The description of the property ownership.Lookup: GET /lookups/OwnershipStatusHH
*ProposerFirstTimeBuyer[boolean]Indicates if the applicants are a first time buyers.
*PropertyOccupiedFromCommencement[boolean]Indicates if the property is going to be lived in from the start of the policy.
PropertyOccupiedFromCompletion[boolean]Indicates if the property is going to be lived in from the completion date.
PropertyOccupiedDateKnown[boolean]Indicates if it is known when the property will be occupied.
PropertyOccupiedDate[date]The date when the property will be occupied
*PropertyOccupancyType[string] (Max 50)The description of how the property is to be used.Lookup: GET /lookups/OccupancyTypesHH
PropertyUnoccupiedReason[string]The reason why the property is unoccupied.Lookup: GET /lookups/UnoccupiedReasonsHH
PropertyUnoccupiedCoverLevel[string]The level of cover required whilst the property is unoccupied.Lookup: GET /lookups/UnoccupiedCoverLevels
PropertyConsecutiveDaysUnoccupied[string] (Max 15)The number of consecutive days that the property will be unoccupied.Lookup: GET /lookups/UnoccupiedConsecutiveDays
*PropertyOccupants[string] (Max 50)The description on who is living in the property.Lookup: GET /lookups/OccupantTypes
*PropertyOccupiedDuringTheNight[boolean]Indicates if the property is occupied overnight.
*PropertyUnoccupiedDuringTheDay[boolean]Indicates if the property is unoccupied during the day.
*PropertySelfContained[boolean]Indicates if anyone else other than the residents has access to the property.
PropertyResidenceType[string]The type of residence.Lookup: GET /lookups/ResidenceTypes
*ProposerRentsOutProperty[boolean]Indicates if the property is to be rented or sub-let.
*ResidentSmoker[boolean]Indicates if anyone who lives in the property smokes.
PropertySmokeDetector[boolean]Indicates if there is a smoke detector in the property.
*PropertyGoodStateOfRepair[boolean]Indicates if the property is in a good condition and able to be lived in.
*PropertyRoofMaterial[string] (Max 60)The description of the roof construction material.Lookup: GET /lookups/RoofTypes
*PropertyHasFlatRoofArea[boolean]Indicates if there is an area of flat roof on the property.
PropertyFlatRoofPercent[string]The percentage of the flat roof area on the property.Lookup: GET /lookups/FlatRoofPercent
PropertyFlatRoofMaterial[string]The description of the flat roof construction material.Lookup: GET /lookups/RoofTypes
*PropertyWallMaterial[string] (Max 60)The description of the wall construction material.Lookup: GET /lookups/WallTypes
*PropertyListedBuilding[boolean]Indicates if the property is a listed building.
PropertyListedBuildingGrade[string]The grade listing of the propertyLookup: GET /lookups/ListedBuildingGrades.
*PropertyConstructionRenovation[boolean]Indicates if there is any construction or renovation work on the property planned in the next 12 months.
PropertyConstructionRenovationValue[integer]The value of the construction or renovation work.
PropertyConstructionRenovationNature[string]The description of the construction or renovation work.Lookup: GET /lookups/ConstructionRenovationNatures
PropertyConstructionRenovationImpact[string]The increase in the size of the property due to renovation or construction work.Lookup: GET /lookups/ConstructionRenovationImpact
PropertyConstructionRenovationStartDate[date]The date for when the work is due to start.
PropertyConstructionRenovationFinishDate[date]The date for when the work is due to finish.
PropertyConstructionRenovationProfessionals[boolean]Indicates if the construction work is being done by professional contractors or tradespeople.
PropertyConstructionRenovationContract[boolean]Indicates if there is a contract between the applicant and contractors or tradespeople.
PropertyConstructionRenovationLiabilityCover[boolean]Indicates if the contractors have there own liability insurance policy.
PropertyConstructionRenovationPlanningPermission[string]Indicates if planning permission has been applied for/obtained.Lookup: GET /lookups/ConstructionRenovationPlanningPermission
*PropertyUsedForBusinessOrTrade[boolean]Indicates if the property is being used for any trade, business or professional purposes.
PropertyTypeOfBusinessUse[string]The description of type of business carried out at the property.Lookup: GET /lookups/BusinessTypeOfUse
PropertyTypeOfWork[string]The type of work carried out at the property.Lookup: GET /lookups/BusinessTypeOfWork
*ProposerInvolvedInEntertainment[boolean]Indicates if the client works within the entertainment industry.
*PropertyNearWatercourse[boolean]Indicates if there is a watercourse, sea, lake, canal or any other body of water within 400m of the property.
*PropertyFloodArea[boolean]Indicates if there has been a history of flooding within 400m of the property.
*PropertyPreviouslyDamagedByFlood[boolean]Indicates if the property, outbuildings or grounds have previously flooded.
PropertyFloodedWithin25Years[boolean]Indicates if the flooding occurred in the last 25 years.
*PropertyRiskSubsidence[boolean]Indicates if there is a cliff, quarry, mining or any other excavation within 400m of the property.
*PropertyAreaSignsSubsidence[boolean]Indicates if there are any signs of subsidence, heave or landslip at the property or in any neighbouring buildings within 400m of the property.
PropertyGardenSignsSubsidence[boolean]Indicates if there are any trees or shrubs within 7m of the property which are more than 3m tall.
*PropertyDamagedSubsidence[boolean]Indicates if the property has been previously damaged by subsidence, heave or landslip.
PropertyUnderpinned[boolean]Indicates if the property has been underpinned or supported by other means of structural work.
PropertyAdequacyCertificate[boolean]Indicates if a certificate of structural adequacy has been issued for the work.
PropertyUnderpinnedDate[date]The date when the property was underpinned.
*PropertySubsidenceSurveyed[boolean]Indicates if any reports or valuations have been received that state the property has been subject to settlement, movement or structural defect.
PropertySubsidenceHistorical[boolean]Indicates if the report states the settlement, movement or structural defect is historical and non-progressive
*ProposerBankruptcyIVAOrCCJ[boolean]Indicates if anyone living in the property has been made bankrupt, entered an IVA or been subject to a CCJ order.
ProposerBankruptcyBankrupt[boolean]Indicates if anyone living in the property has been made bankrupt.
ProposerBankruptcyDischarged[boolean]Indicates if the bankruptcy has been discharged.
ProposerBankruptcyDischargedDate[date]The date when the bankruptcy was discharged.
ProposerBankruptcyIVA[boolean]Indicates if anyone living in the property has an IVA.
ProposerBankruptcyIVASatisfied[boolean]Indicates if the IVA has been satisfied.
ProposerBankruptcyIVASatisfiedDate[date]The date when the IVA was satisfied.
ProposerBankruptcyCCJs[boolean]Indicates if anyone living in the property has had a CCJ.
ProposerBankruptcyNumCCJs[integer]The total number of CCJs that have been issued to anybody living in the home.
ProposerBankruptcyCCJSatisfied[boolean]Indicates if all the CCJs have been satisfied.
ProposerBankruptcyCCJSatisfiedDate[date]The date the last CCJ was satisfied.
*ProposerRefusedInsurance[boolean]Indicates if anybody living in the property has had insurance cancelled, turned down or had additional terms placed on the policy.
SpecialTermReason[string]The reason for the cancellation, refusal or additional terms.Lookup: GET /lookups/SpecialTermReasons
SpecialTermDate[date]The date when the special terms were imposed.
*ProposerConvictedCharged[boolean]Indicates if anyone living in the property has had an unspent conviction.
*ProposerContinuousInsurance[boolean]Indicates if the applicant has had continuous insurance with no gaps in cover.
*NumberResidentAdults[integer]The number of adults, aged 18 and over, living in the property.
*NumberResidentChildren[integer]The number of children aged under 18 living in the property.
*ProposerClaimsOrLosses[boolean]Indicates if the anyone living in the property has made a claim or suffered a loss or damage in the last 5 years.
InsuredHouseNumber[string] (Max 30)The house name or number of the risk address.
*PropertyType[string] (Max 50)The description of the type of property.Lookup: GET /lookups/PropertyTypesHH
PropertyFlatFloorNumber[string]The floor number that they live on if the property is a flat.Lookup: GET /lookups/FlatFloorNumbers
*PropertyConstructionYear[integer]The year that the oldest part of the property was built.
*PropertyNumberOfBedrooms[integer]The number of bedrooms in the property.
*BuildingsSelected[boolean]Indicates if buildings cover is required.
BuildingsSumInsured[integer]The rebuild cost of the property (not its market value).
BuildingsAccidentalDamage[boolean]Indicates if accidental damage is required on the buildings cover.
BuildingsExcessVoluntary[integer]The voluntary excess for the buildings cover.Lookup: GET /lookups/VoluntaryExcess
BuildingsNCD[integer]The number of consecutive years that the applicant has not made a buildings claim.
*ContentsSelected[boolean]Indicates if contents cover is required.
ContentsSumInsured[integer]The replacement cost all of the contents in the property.
ContentsAccidentalDamage[boolean]Indicates if accidental damage is required on the contents cover.
ContentsExcessVoluntary[integer]The voluntary excess for the contents cover if requested.Lookup: GET /lookups/VoluntaryExcess
ContentsNCD[integer]The number of consecutive years that the applicant has not made a contents claim.
PossessionsUnspecifiedSumInsured[integer]The maximum amount of cover required for items away from the home valued under £1,000.
*ExternalDoorLocksType[string] (Max 100)The type of locks on the external doors.Lookup: GET /lookups/LockTypes
*SlidingDoors[boolean]Indicates if the property has french doors or external sliding doors.
SlidingDoorLocksType[string] (Max 100)The type of locks for the french or external sliding doors.Lookup: GET /lookups/LockTypes
*OtherExternalDoors[boolean]Indicates if there any other external doors.
OtherExternalDoorLocksType[string] (Max 100)The type of locks on any other external doors.Lookup: GET /lookups/LockTypes
*WindowLocks[boolean]Indicates if all accessible windows are fitted with key operated locks.
*PropertyAlarm[boolean]Indicates if an approved alarm has been installed on the property.
AlarmMaintained[boolean]Indicates if the alarm is maintained by an approved contractor.
*HomeEmergencyCover[boolean]Indicates if home emergency cover is required.
*PedalCyclesRequired[boolean]Indicates if pedal cycle cover is required.
InceptionDate[date]The date that the policy will start from.
InsuredAddress1[string] (Max 50)The insured address line 1 of the property.
InsuredAddress2[string] (Max 50)The insured address line 2 of the property.
InsuredAddress3[string] (Max 50)The insured address line 3 of the property.
InsuredAddress4[string] (Max 50)The insured address line 4 of the property.
InsuredAddress5[string] (Max 50)The insured address line 5 of the property.
*Type[string] (Max 50)The type or category of the claim.Lookup: GET /lookups/ClaimCategories
*Description[string] (Max 100)The description of the claim.Lookup: GET /lookups/ClaimDescriptions
*Date[date]The date of the claim.
*CurrentProperty[boolean]Indicates if the claim was made on the current property.
*ResultedInPayment[boolean]Indicates if the claim resulted in a payment.
*Settled[boolean]Indicates if the claim has been settled.
*SettlementAmount[decimal]The claim settlement amount.
SettlementDate[date]The date of the claim settlement.
*Category[string] (Max 100)The category of the item.Lookup: GET /lookups/HighRiskItems or Lookups.HighRiskItemsInsurableAwayFromHome
*Description[string] (Max 100)The description of the item.
*Value[decimal]The replacement cost of the item.
*CoverAwayFromProperty[boolean]Indicates if the item requires cover away from the property.
*Make[string] (Max 100)The make of the pedal cycle.
*Model[string] (Max 100)The model of the pedal cycle.
*Value[decimal]The replacement cost of the pedal cycle.
*CoverAwayFromProperty[boolean]Indicates if the pedal cycle requires cover away from the property.
*Type[string] (Max 100)The type of conviction.Lookup: GET /lookups/ConvictionTypes
*Person[string] (Max 20)The person convicted.Lookup: GET /lookups/ConvictionPersonHH
*Date[date]The date of the conviction.
*Sentence[string] (Max 50)The conviction sentence.Lookup: GET /lookups/ConvictionSentences
*ProposerOwnershipStatus[string] (Max 50)The description of the property ownership.Lookup: GET /lookups/OwnershipStatusLP
*PropertyOccupancyType[string] (Max 50)The description of how the property is to be used.Lookup: GET /lookups/OccupancyTypesLP
PropertyUnoccupiedReason[string]The reason why the property is unoccupiedLookup: GET /lookups/UnoccupiedReasonsLP.
PropertyUnoccupiedCoverLevel[string]The level of cover required whilst the property is unoccupied.Lookup: GET /lookups/UnoccupiedCoverLevels
*PropertySelfContained[boolean]Indicates if anyone else other than the residents has access to the property.
*PropertyOccupiedFromCommencement[boolean]Indicates if the property is going to be lived in from the start of the policy.
PropertyOccupiedWithin60DaysOfCommencement[boolean]Indicates if the property will be lived in within 60 days from the start date.
*PropertyMultipleOccupancy[boolean]Indicates if the property is being let to multiple tenants who are not related to each other.
NumberOfTenants[integer]The number of tenants living in the property.
*TenantType[string] (Max 30)The type of tenant living in the property.Lookup: GET /lookups/TenantTypes
*PropertyUnoccupiedOver12MonthsPriorToPolicy[boolean]Indicates if the property has been unoccupied for over 12 months before the start date of the policy.
*PropertyAgreementDirectlyWithTenant[boolean]Indicates if the tenancy agreement is directly between the tenant and the policyholder and it is for at least 6 months.
*PropertyDividedIntoBedsits[boolean]Indicates if the property is divided into bedsits.
*PropertyGoodStateOfRepair[boolean]Indicates if the property is in a good condition and able to be lived in.
*PropertyFirePreventionPresent[boolean]Indicates if there are any fire detection or prevention facilities in the property.
*PropertyRoofMaterial[string] (Max 60)The description of the roof construction material.Lookup: GET /lookups/RoofTypes
*PropertyHasFlatRoofArea[boolean]Indicates if there is an area of flat roof on the property.
PropertyFlatRoofPercent[string]The percentage of the flat roof area on the property.Lookup: GET /lookups/FlatRoofPercent
PropertyFlatRoofMaterial[string]The description of the flat roof construction material.Lookup: GET /lookups/RoofTypes
*PropertyWallMaterial[string] (Max 60)The description of the wall construction material.Lookup: GET /lookups/WallTypes
*PropertyListedBuilding[boolean]Indicates if the property is a listed building.
PropertyListedBuildingGrade[string]The grade listing of the property.Lookup: GET /lookups/ListedBuildingGrades
*PropertyConstructionRenovation[boolean]Indicates if there is any construction or renovation work on the property planned in the next 12 months.
PropertyConstructionRenovationValue[integer]The value of the construction or renovation work.
PropertyConstructionRenovationNature[string]The description of the construction or renovation work.Lookup: GET /lookups/ConstructionRenovationNatures
PropertyConstructionRenovationImpact[string]The increase in the size of the property due to renovation or construction work.Lookup: GET /lookups/ConstructionRenovationImpact
PropertyConstructionRenovationStartDate[date]The date for when the work is due to start.
PropertyConstructionRenovationFinishDate[date]The date for when the work is due to finish.
PropertyConstructionRenovationProfessionals[boolean]Indicates if the construction work is being done by professional contractors or tradespeople.
PropertyConstructionRenovationContract[boolean]Indicates if there is a contract between the applicant and contractors or tradespeople.
PropertyConstructionRenovationLiabilityCover[boolean]Indicates if the contractors have there own Liability Insurance Policy.
PropertyConstructionRenovationPlanningPermission[string]Indicates if planning permission has been applied for/obtained.Lookup: GET /lookups/ConstructionRenovationPlanningPermission
*PropertyNearWatercourse[boolean]Indicates if there is a watercourse, sea, lake, canal or any other body of water within 400m of the property
*PropertyFloodArea[boolean]Indicates if there has been a history of flooding within 400m of the property.
*PropertyPreviouslyDamagedByFlood[boolean]Indicates if the property, outbuildings or grounds have previously flooded.
PropertyFloodedWithin25Years[boolean]Indicates if the flooding occurred in the last 25 years.
*PropertyRiskSubsidence[boolean]Indicates if there is a cliff, quarry, mining or any other excavation within 400m of the property.
*PropertyAreaSignsSubsidence[boolean]Indicates if there are any signs of subsidence, heave or landslip at the property or in any neighbouring buildings within 400m of the property.
PropertyGardenSignsSubsidence[boolean]Indicates if there are any trees or shrubs within 7m of the property which are more than 3m tall.
*PropertyDamagedSubsidence[boolean]Indicates if the property has been previously damaged by subsidence, heave or landslip.
PropertyUnderpinned[boolean]Indicates if the property has been underpinned or supported by other means of structural work
PropertyAdequacyCertificate[boolean]Indicates if a certificate of structural adequacy has been issued for the work.
PropertyUnderpinnedDate[date]The date when the property was underpinned.
*PropertySubsidenceSurveyed[boolean]Indicates if any reports or valuations have been received that state the property has been subject to settlement, movement or structural defect.
PropertySubsidenceHistorical[boolean]Indicates if the report states the settlement, movement or structural defect is historical and non-progressive.
*ProposerBankruptcyIVAOrCCJ[boolean]Indicates if anyone living in the property has been made bankrupt, entered an IVA or been subject to a CCJ order.
ProposerBankruptcyBankrupt[boolean]Indicates if anyone living in the property has been made bankrupt.
ProposerBankruptcyDischarged[boolean]Indicates if the bankruptcy has been discharged.
ProposerBankruptcyDischargedDate[date]The date when the bankruptcy was discharged.
ProposerBankruptcyIVA[boolean]Indicates if anyone living in the property has an IVA.
ProposerBankruptcyIVASatisfied[boolean]Indicates if the IVA has been satisfied.
ProposerBankruptcyIVASatisfiedDate[date]The date when the IVA was satisfied.
ProposerBankruptcyCCJs[boolean]Indicates if anyone living in the property has had a CCJ.
ProposerBankruptcyNumCCJs[integer]The total number of CCJs that have been issued to anybody living in the home.
ProposerBankruptcyCCJDate[date]The date that the last CCJ was issued.
ProposerBankruptcyCCJSatisfied[boolean]Indicates if all the CCJs have been satisfied.
ProposerBankruptcyCCJSatisfiedDate[date]The date the last CCJ was satisfied.
*ProposerRefusedInsurance[boolean]Indicates if anybody living in the property has had insurance cancelled, turned down or had additional terms placed on the policy.
SpecialTermReason[string]The reason for the cancellation, refusal or additional terms.Lookup: GET /lookups/SpecialTermReasons
SpecialTermDate[date]The date when the special terms were imposed.
*ProposerClaimsOrLosses[boolean]Indicates if the anyone living in the property has made a claim or suffered a loss or damage in the last 5 years.
*ProposerConvictedCharged[boolean]Indicates if anyone living in the property has had an unspent conviction.
*ProposerContinuousInsurance[boolean]Indicates if the applicant has had continuous insurance with no gaps in cover.
InsuredHouseNumber[string] (Max 30)The house name or number of the risk address.
InsuredAddress1[string] (Max 50)The insured address line 1 of the property.
InsuredAddress2[string] (Max 50)The insured address line 2 of the property.
InsuredAddress3[string] (Max 50)The insured address line 3 of the property.
InsuredAddress4[string] (Max 50)The insured address line 4 of the property.
InsuredAddress5[string] (Max 50)The insured address line 5 of the property.
*InsuredPostcode[string] (Max 8)The postcode of the risk address.
*PropertyType[string] (Max 50)The description of the type of property.Lookup: GET /lookups/PropertyTypesLP
PropertyNumberOfUnits[integer]The total number of flats in the block.
*PropertyConstructionYear[integer]The year that the oldest part of the property was built.
*PropertyNumberOfBedrooms[integer]The number of bedrooms in the property.
*BuildingsSelected[boolean]Indicates if buildings cover is required.
BuildingsSumInsured[integer]The rebuild cost of the property (not its market value).
BuildingsAccidentalDamage[boolean]Indicates if accidental damage is required on the buildings cover.
BuildingsExcessVoluntary[integer]The voluntary excess for the buildings cover.Lookup: GET /lookups/VoluntaryExcess
BuildingsNCD[integer]The number of consecutive years that the applicant has not made a buildings claim.
*ContentsSelected[boolean]Indicates if contents cover is required.
ContentsSumInsured[integer]The replacement cost all of the contents in the property.
ContentsAccidentalDamage[boolean]Indicates if accidental damage is required on the contents cover.
ContentsExcessVoluntary[integer]The voluntary excess for the contents cover if requested.Lookup: GET /lookups/VoluntaryExcess
ContentsNCD[integer]The number of consecutive years that the applicant has not made a contents claim.
*MalicionsDamageCover[boolean]Indicates if malicious damage by tenant cover is required.
*EmployersLiabilityCover[boolean]Indicates if employers liability cover is required for any domestic staff.
*PropertyOwnersLiabilityCover[boolean]Indicates if property owners liability cover is required.
*PropertyOwnersLiabilitySumInsured[integer]The property owners liability sum insured.Lookup: GET /lookups/PropertyOwnersLiabilitySumInsured
*ContentsTheftCover[boolean]Indicates if theft of contents cover is required.
*RentGuaranteeCover[boolean]Indicates if rent guaranteee cover is required.
*RentGuaranteeMonthlyAmount[integer]The required monthly rent cover per calendar month.
*RentGuaranteeIndemnityPeriod[integer]The number of months indemnity required for rent guarantee cover.
*HomeEmergencyCover[boolean]Indicates if home emergency cover is required.
*ExternalDoorLocksType[string] (Max 100)The type of locks on the external doors.Lookup: GET /lookups/LockTypes
*SlidingDoors[boolean]Indicates if the property has french doors or external sliding doors.
*SlidingDoorLocksType[string] (Max100)The type of locks for the french or external sliding doors.Lookup: GET /lookups/LockTypes
*OtherExternalDoors[boolean]Indicates if there any other external doors.
OtherExternalDoorLocksType[string] (Max 100)The type of locks on any other external doors.Lookup: GET /lookups/LockTypes
*WindowLocks[boolean]Indicates if all accessible windows are fitted with key operated locks.
*PropertyAlarm[boolean]Indicates if an approved alarm has been installed on the property.
AlarmMaintained[boolean]Indicates if the alarm is maintained by an approved contractor.
Type[string]The type or category of the claim.Lookup: GET /lookups/ClaimCategories
Description[string]The description of the claim.Lookup: GET /lookups/ClaimDescriptions
Date[date]The date of the claim.
CurrentProperty[boolean]Indicates if the claim was made on the current property.
ResultedInPayment[boolean]Indicates if the claim resulted in a payment.
Settled[boolean]Indicates if the claim has been settled.
SettlementAmount[decimal]The claim settlement amount.
Type[string]The type of conviction.Lookup: GET /lookups/ConvictionTypes
Person[string]The person convicted.Lookup: GET /lookups/ConvictionPersonLP
Date[string]The date of the conviction.
Sentence[string]The conviction sentence.Lookup: GET /lookups/ConvictionSentences
*Gender[string]The gender of the applicant.Lookup: GET /lookups/Gender
InsuredAddress1[string] (Max 50)The insured address line 1 of the property.
InsuredAddress2[string] (Max 50)The insured address line 2 of the property.
InsuredAddress3[string] (Max 50)The insured address line 3 of the property.
InsuredAddress4[string] (Max 50)The insured address line 4 of the property.
InsuredAddress5[string] (Max 50)The insured address line 5 of the property.
*InsuredPostcode[string] (Max 8)The postcode of the risk address.
*UKResident[boolean]Indicates whether the applicant is a resident within the UK.
*UKResident6MonthsContinuous[boolean]Indicates whether the applicant has been residing in the UK continuously for the last 6 months.
*SmokerStatus[string]Indicates whether the applicant is a smoker.Lookup: GET /lookups/SmokerStatus
SmokerQuitDeclaration[string]Length of time the applicant has stopped smoking.Lookup: GET /lookups/SmokerQuitDeclaration
*GrossAnnualIncome[decimal]The gross annual income of the applicant.
*ReceivedTreatment[boolean]Indicates whether the applicant has received treatment or medication for a medical condition in the last 12 months.
*ConsultedDoctor[boolean]Indicates whether the applicant is awaiting referral or consultation for any condition or is off work at the time of completing the application.
*HoursWorkAWeek[string]The amount of hours a week the applicant works.Lookup: GET /lookups/HoursWorkAWeek
*EmployerName[string] (Max 100)The name of the applicant's employer.
*EmploymentStatus[string]Employment type of the applicant.Lookup: GET /lookups/EmploymentStatus
EmployedAndShareholdingDirector[boolean]Indicates whether the applicant is a Shareholding Director.
EmployedAndProprietor[boolean]Indicates whether the applicant is a Proprietor.
EmploymentContractType[string]Employment contract type of the applicant.Lookup: GET /lookups/EmploymentContractType
*ContinuousEmploymentDeclaration[string]The length of time the applicant has been in continuous employment.Lookup: GET /lookups/ContinuousEmploymentDeclaration
*UKWorker6MonthsContinuous[boolean]Indicates whether the applicant is continuously working in the UK for the last 6 months.
*CurrentlyAttendingWork[boolean]Indicates whether the applicant is currently in work.
*TemporaryWorker[boolean]Indicates whether the applicant's work is temporary, casual or seasonal.
*RiskOfUnemployment[boolean]Indicates whether the applicant is aware of any redundancies, restructure, reorganisation, financial or contractual threats within the business they work in, even if they do not believe these actions will result in you becoming unemployed.
*ProtectionType[string]Type of cover e.g.income, rent, mortgage.Lookup: GET /lookups/ProtectionType
MortgageTypeAtInception[string]Applicant's mortgage type e.g. new, existing, remortgage.Lookup: GET /lookups/MortgageType
PropertyOwnershipStatus[string]Property ownership status e.g. owned outright or on a mortage.Lookup: GET /lookups/OwnershipStatusASU
MonthlyMortgageOrRentAmount[decimal]Monthly mortgage repayment amount.
*MonthlyCoverAmount[decimal]The monthly amount you will receive in the event of a claim.
*RisksCovered[string]Risks covered e.g.Accident and Sickness, Unemployment, Accident Sickness and Unemployment.Lookup: GET /lookups/RisksCovered
PolicyExcessDaysAS[integer]Number of days at the start of a claim when you are not entitled to a benefit.Lookup: GET /lookups/PolicyExcessDays
PolicyExcessDaysU[integer]Number of days at the start of a claim when you are not entitled to a benefit.Lookup: GET /lookups/PolicyExcessDays
*BenefitPeriodMonths[integer]Maximum number of monthly benefit payments payable for a single claim.Lookup: GET /lookups/BenefitPeriodMonths
*HasExistingPolicy[boolean]Has a policy that already covers you for the insurance type you have selected
SchemeTransfer[boolean]Indicates transfer cover from an existing scheme.
*ProposerClaimsOrLosses[boolean]Indicates whether applicant has made a claim within the last 24 months.
POST https://api.thesource.co.uk/api/quotes HTTP/1.1
{
"Delegated": false,
"QuickQuote": false,
"Title1": "Mr",
"FirstName1": "John",
"Surname1": "Doe",
"Occupation1": "Abattoir Worker",
"NatureOfBusiness1": "Abattoir",
"DOB1": "1977-06-25T00:00:00",
"Email1": "[email protected]",
"Title2": "Mrs",
"FirstName2": "Jane",
"Surname2": "Doe",
"DOB2": "1980-09-12T00:00:00",
"Email2": "[email protected]",
"Occupation2": "Abattoir Worker",
"NatureOfBusiness2": "Abattoir",
"ElectronicDoc": false,
"CommissionRate": 0,
"ProductType": "Household",
"Household": {
"InsuredPostcode": "CF64 3TP",
"ProposerOwnershipStatus": "Yes - Owned Outright",
"ProposerFirstTimeBuyer": false,
"PropertyOccupiedFromCommencement": true,
"PropertyOccupiedFromCompletion": true,
"PropertyOccupiedDateKnown": true,
"PropertyOccupiedDate": "2015-04-21T00:00:00",
"PropertyOccupancyType": "Your main residence & Occupied",
"PropertyUnoccupiedReason": "Owner working abroad",
"PropertyUnoccupiedCoverLevel": "Fire, Lightning, Explosion, Earthquake, Aircraft & Subsidence",
"PropertyConsecutiveDaysUnoccupied": "Up to 30 days",
"PropertyOccupants": "You",
"PropertyOccupiedDuringTheNight": true,
"PropertyUnoccupiedDuringTheDay": true,
"PropertySelfContained": true,
"PropertyResidenceType": "Nursing home",
"ProposerRentsOutProperty": false,
"ResidentSmoker": false,
"PropertySmokeDetector": true,
"PropertyGoodStateOfRepair": true,
"PropertyRoofMaterial": "Tile",
"PropertyHasFlatRoofArea": false,
"PropertyFlatRoofPercent": "0%-20%",
"PropertyFlatRoofMaterial": "Glass",
"PropertyWallMaterial": "Brick",
"PropertyListedBuilding": false,
"PropertyListedBuildingGrade": "",
"PropertyConstructionRenovation": false,
"PropertyConstructionRenovationValue": 0,
"PropertyConstructionRenovationNature": "",
"PropertyConstructionRenovationImpact": "",
"PropertyConstructionRenovationStartDate": "2015-02-20T00:00:00",
"PropertyConstructionRenovationFinishDate": "2015-06-20T00:00:00",
"PropertyConstructionRenovationProfessionals": true,
"PropertyConstructionRenovationContract": true,
"PropertyConstructionRenovationLiabilityCover": true,
"PropertyConstructionRenovationPlanningPermission": "Not Required",
"PropertyUsedForBusinessOrTrade": false,
"PropertyTypeOfBusinessUse": "",
"PropertyTypeOfWork": "",
"ProposerInvolvedInEntertainment": false,
"PropertyNearWatercourse": false,
"PropertyFloodArea": false,
"PropertyPreviouslyDamagedByFlood": false,
"PropertyFloodedWithin25Years": false,
"PropertyRiskSubsidence": false,
"PropertyAreaSignsSubsidence": false,
"PropertyGardenSignsSubsidence": false,
"PropertyDamagedSubsidence": false,
"PropertyUnderpinned": false,
"PropertyAdequacyCertificate": false,
"PropertyUnderpinnedDate": "2002-04-23T00:00:00",
"PropertySubsidenceSurveyed": false,
"PropertySubsidenceHistorical": false,
"ProposerBankruptcyIVAOrCCJ": false,
"ProposerBankruptcyBankrupt": false,
"ProposerBankruptcyDischarged": false,
"ProposerBankruptcyDischargedDate": "2012-11-07T00:00:00",
"ProposerBankruptcyIVA": false,
"ProposerBankruptcyIVASatisfied": false,
"ProposerBankruptcyIVASatisfiedDate": "2007-06-05T00:00:00",
"ProposerBankruptcyCCJs": false,
"ProposerBankruptcyNumCCJs": 0,
"ProposerBankruptcyCCJDate": "2009-12-28T00:00:00",
"ProposerBankruptcyCCJSatisfied": false,
"ProposerBankruptcyCCJSatisfiedDate": "2010-06-21T00:00:00",
"ProposerRefusedInsurance": false,
"SpecialTermReason": null,
"SpecialTermDate": "0001-01-01T00:00:00",
"ProposerConvictedCharged": false,
"ProposerContinuousInsurance": true,
"NumberResidentAdults": 2,
"NumberResidentChildren": 3,
"ProposerClaimsOrLosses": true,
"InsuredHouseNumber": "Numero dos",
"PropertyType": "Semi-Detached House",
"PropertyFlatFloorNumber": "",
"PropertyConstructionYear": 1980,
"PropertyNumberOfBedrooms": 3,
"BuildingsSelected": true,
"BuildingsSumInsured": 150000,
"BuildingsAccidentalDamage": true,
"BuildingsExcessVoluntary": 100,
"BuildingsNCD": 2,
"ContentsSelected": true,
"ContentsSumInsured": 25000,
"ContentsAccidentalDamage": true,
"ContentsExcessVoluntary": 100,
"ContentsNCD": 2,
"PossessionsUnspecifiedSumInsured": 5000,
"ExternalDoorLocksType": "More than 1 lock",
"SlidingDoors": true,
"SlidingDoorLocksType": "Key to lock and unlock - pull down lever to enter",
"OtherExternalDoors": true,
"OtherExternalDoorLocksType": "Other - the lock on my main door is different to the ones illustrated",
"WindowLocks": true,
"PropertyAlarm": true,
"AlarmMaintained": true,
"HomeEmergencyCover": false,
"PedalCyclesRequired": true,
"HighRiskItemsRequired": true,
"Claims": [{
"Type" : "Buildings",
"Description" : "Accidental Damage to Buildings",
"Date" : "2013-12-28T00:00:00",
"CurrentProperty" : false,
"ResultedInPayment" : true,
"Settled" : true,
"SettlementAmount" : 6000
},
{
"Type" : "Contents",
"Description" : "Accidental Damage to Contents",
"Date" : "2012-12-28T00:00:00",
"CurrentProperty" : true,
"ResultedInPayment" : false,
"Settled" : false,
"SettlementAmount" : 3000
}],
"HighRiskItems": [{
"Category" : "Clocks",
"Description" : "Grandad's Clock",
"Value" : "3200",
"CoverAwayFromProperty" : false
},
{
"Category" : "Jewellery/Watches",
"Description" : "Pearl Necklace",
"Value" : "4000",
"CoverAwayFromProperty" : true
}],
"PedalCycles": [{
"Make" : "Halfords",
"Model" : "Speeder X",
"Value" : "921",
"CoverAwayFromProperty" : true
},
{
"Make" : "Apollo",
"Model" : "21T",
"Value" : "800",
"CoverAwayFromProperty" : true
}],
"Convictions": [{
"Type" : "Theft",
"Person" : "Proposer(s)",
"Date" : "2009-12-28T00:00:00",
"Sentence" : "Fine"
},
{
"Type" : "Drunk & Disorderly",
"Person" : "Proposer(s)",
"Date" : "2007-12-28T00:00:00",
"Sentence" : "Community Service"
}]
},
"LetProperty": null,
"ASU": null
}
POST https://api.thesource.co.uk/api/quotes HTTP/1.1
{
"Delegated": false,
"QuickQuote": false,
"Title1": "Mr",
"FirstName1": "John",
"Surname1": "Doe",
"Occupation1": "Abattoir Worker",
"NatureOfBusiness1": "Abattoir",
"DOB1": "1965-02-23",
"Email1": "[email protected]",
"Title2": "Mrs",
"FirstName2": "Jane",
"Surname2": "Doe",
"DOB2": "1980-09-12",
"Email2": "[email protected]",
"Occupation2": "Abattoir Worker",
"NatureOfBusiness2": "Abattoir",
"ElectronicDoc": false,
"CommissionRate": 0,
"ProductType": "LetProperty",
"LetProperty": {
"ProposerOwnershipStatus": "Yes - Mortgaged",
"PropertyOccupancyType": "Let to Tenants",
"PropertyUnoccupiedReason": "",
"PropertyUnoccupiedCoverLevel": "",
"PropertySelfContained": true,
"PropertyOccupiedFromCommencement": true,
"PropertyOccupiedWithin60DaysOfCommencement": false,
"PropertyMultipleOccupancy": false,
"NumberOfTenants": 1,
"TenantType": "Working/Retired People",
"PropertyUnoccupiedOver12MonthsPriorToPolicy": false,
"PropertyAgreementDirectlyWithTenant": true,
"PropertyDividedIntoBedsits": false,
"PropertyGoodStateOfRepair": true,
"PropertyFirePreventionPresent": true,
"PropertyRoofMaterial": "Tile",
"PropertyHasFlatRoofArea": false,
"PropertyFlatRoofPercent": "21%-30%",
"PropertyFlatRoofMaterial": "Concrete",
"PropertyWallMaterial": "Brick",
"PropertyListedBuilding": false,
"PropertyListedBuildingGrade": "",
"PropertyConstructionRenovation": false,
"PropertyConstructionRenovationValue": 0,
"PropertyConstructionRenovationNature": "",
"PropertyConstructionRenovationImpact": "",
"PropertyConstructionRenovationStartDate": "2015-02-20",
"PropertyConstructionRenovationFinishDate": "2015-06-20",
"PropertyConstructionRenovationProfessionals": true,
"PropertyConstructionRenovationContract": true,
"PropertyConstructionRenovationLiabilityCover": true,
"PropertyConstructionRenovationPlanningPermission": "Not Required",
"PropertyNearWatercourse": false,
"PropertyFloodArea": false,
"PropertyPreviouslyDamagedByFlood": false,
"PropertyFloodedWithin25Years": false,
"PropertyRiskSubsidence": false,
"PropertyAreaSignsSubsidence": false,
"PropertyGardenSignsSubsidence": false,
"PropertyDamagedSubsidence": false,
"PropertyUnderpinned": false,
"PropertyAdequacyCertificate": true,
"PropertyUnderpinnedDate": "2002-04-23",
"PropertySubsidenceSurveyed": false,
"PropertySubsidenceHistorical": false,
"ProposerBankruptcyIVAOrCCJ": false,
"ProposerBankruptcyBankrupt": false,
"ProposerBankruptcyDischarged": false,
"ProposerBankruptcyDischargedDate": "2012-11-07",
"ProposerBankruptcyIVA": false,
"ProposerBankruptcyIVASatisfied": false,
"ProposerBankruptcyIVASatisfiedDate": "2007-06-05",
"ProposerBankruptcyCCJs": false,
"ProposerBankruptcyNumCCJs": 3,
"ProposerBankruptcyCCJSatisfied": false,
"ProposerBankruptcyCCJSatisfiedDate": "2010-06-21",
"ProposerRefusedInsurance": false,
"SpecialTermReason": null,
"SpecialTermDate": null,
"ProposerContinuousInsurance": true,
"InsuredHouseNumber": "62a",
"InsuredPostcode": "CF64 1EH",
"PropertyType": "Detached House",
"PropertyNumberOfUnits": "3",
"PropertyConstructionYear": 1980,
"PropertyNumberOfBedrooms": 3,
"BuildingsSelected": true,
"BuildingsSumInsured": 180000,
"BuildingsAccidentalDamage": true,
"BuildingsExcessVoluntary": 400,
"BuildingsNCD": 2,
"ContentsSelected": true,
"ContentsSumInsured": 10000,
"ContentsAccidentalDamage": true,
"ContentsExcessVoluntary": 400,
"ContentsNCD": 2,
"MaliciousDamageCover": false,
"EmployersLiabilityCover": false,
"PropertyOwnersLiabilityCover": false,
"PropertyOwnersLiabilitySumInsured": 0,
"ContentsTheftCover": false,
"RentGuaranteeCover": false,
"RentGuaranteeMonthlyAmount": 0,
"RentGuaranteeIndemnityPeriod": 0,
"HomeEmergencyCover": false,
"ExternalDoorLocksType": "UPVC or aluminium door with multi-point locking system",
"SlidingDoors": true,
"SlidingDoorLocksType": "Basic lock such as Yale",
"OtherExternalDoors": true,
"OtherExternalDoorLocksType": "More than 1 lock",
"WindowLocks": true,
"PropertyAlarm": true,
"AlarmMaintained": true,
"ProposerClaimsOrLosses": false,
"ProposerConvictedCharged": false,
"Claims": [],
"Convictions": []
}
"Household": null,
"ASU": null
}
POST https://api.thesource.co.uk/api/quotes HTTP/1.1
{
"Delegated": false,
"QuickQuote": false,
"Title1": "Mr",
"FirstName1": "John",
"Surname1": "Doe",
"Occupation1": "Abattoir Worker",
"NatureOfBusiness1": "Abattoir",
"DOB1": "1982-12-29T00:00:00",
"Email1": "[email protected]",
"Title2": "",
"FirstName2": "",
"Surname2": "",
"DOB2": "",
"Email2": "",
"Occupation2": "",
"NatureOfBusiness2": "",
"ReplaceExistingPolicy": false,
"ReplaceExistingPolicyReference": "",
"ReplaceExistingPolicyDate": "",
"AdditionalNotes": "Some additional notes in here",
"CommissionRate": 25,
"ElectronicDoc" : true,
"ProductType": "ASU",
"ASU": {
"Gender" : "Male",
"InsuredPostcode": "CF64 3TP",
"InsuredAddress1": "Source Insurance",
"InsuredAddress2": "Drake House",
"InsuredAddress3": "Plymouth Road",
"InsuredAddress4": "Penarth",
"InsuredAddress5": "Vale of Glamorgan",
"UKResident": true,
"UKResident6MonthsContinuous": true,
"SmokerStatus": "Ex-smoker",
"SmokerQuitDeclaration": "Less than 6 months ago",
"GrossAnnualIncome": 20000.00,
"ReceivedTreatment": false,
"ConsultedDoctor": false,
"HoursWorkAWeek": "16 hours or more",
"EmployerName": "Source Insurance",
"EmploymentStatus": "Employed",
"EmployedAndShareholdingDirector": false,
"EmployedAndProprietor": false,
"EmploymentContractType": "Employed Fixed Contract",
"ContinuousEmploymentDeclaration": "12 months or more",
"UKWorker6MonthsContinuous": true,
"CurrentlyAttendingWork": true,
"TemporaryWorker": false,
"RiskOfUnemployment": false,
"ProtectionType": "Mortgage",
"MortgageTypeAtInception": "Existing Mortgage",
"PropertyOwnershipStatus": "Home owned on a Mortgage",
"MonthlyMortgageOrRentAmount": 1500.00,
"MonthlyCoverAmount": 100.00,
"RisksCovered": "Accident, Sickness and Unemployment",
"PolicyExcessDaysAS": 90,
"PolicyExcessDaysU": 30,
"BenefitPeriodMonths": 12,
"HasExistingPolicy": false,
"SchemeTransfer": null,
"FractureCover": false,
"ProposerClaimsOrLosses": true,
"Claims": [
{
"Type": "Accident/Sickness",
"StartDate": "2016-03-01",
"EndDate": "2017-03-01"
},
{
"Type": "Unemployment",
"StartDate": "2016-03-01",
"EndDate": "2017-03-01"
}
]
}
"Household": null,
"LetProperty": null
}
Endorsement objects hold details of a endorsement for a policy.
The API allows you to view endorsement records.
NOTE: The product code can be found in Get a Quote result.
idUnique Identifier.
CodeThe endorsement code.
TitleThe endorsement title.
TextThe endorsement details.
ProductCodeThe product code.
Relative endpoint: GET /endorsements?id=0018&productCode=sx
You must supply a X-Broker-Authentication header with the broker's username and password.
idThe endorsement code.
productCodeThe product code.
GET https://api.thesource.co.uk/api/endorsements?id=0018&productCode=sx HTTP/1.1
HTTP/1.1 200 (OK)
{
"id": "453",
"Code": "0018",
"Title": "Alarm Condition",
"Text": "Whenever the home is left unattended or when the residents retire...",
"ProductCode": "sx"
}
Document objects hold details of a document for a policy.
The API allows you to view document records.
id[string]Unique Identifier.
PolicyholderId[string]The id of the policyholder.
BrokerId[string]The id of the broker.
DocumentType[string]The type(s) of policy document. (Comma seperated list if multiple are returned)
ContentType[string]The content (MIME) type of the document.
Bytes[byte]The document as bytes.
Relative endpoint: GET /documents?clientRef=i12345&transRef=i67890&documentName={Lookup:Documents}
You must supply a X-Broker-Authentication header with the broker's username and password.
N.B. Lookup: (The name of the Lookups class from which permitted values must be taken)
GET https://api.thesource.co.uk/api/documents?clientRef=i12345&transRef=i12345&documentName=Statement%20Of%20Fact HTTP/1.1
HTTP/1.1 200 (OK)
{
"id": "i99999",
"PolicyholderId": "i12345",
"BrokerId": "111111",
"DocumentType": "Statement Of Fact",
"ContentType": "application/pdf",
"Bytes": "JVBERi0xLjMNJeLjz9MNCjEg..."
}
Relative endpoint: GET /documents/s3694225
You must supply a X-Broker-Authentication header with the broker's username and password.
GET https://api.thesource.co.uk/api/documents/s3694225 HTTP/1.1
HTTP/1.1 200 (OK)
{
"id": "s3694225",
"PolicyholderId": "s321965",
"DocumentType": "Home Buyers PI - Policy Wording",
"ContentType": "application/pdf",
"Bytes": "JVBERi0xLjMNJeLjz9MNCjEg..."
}
Relative endpoint: POST /documents
You must supply a X-Broker-Authentication header with the broker's username and password.
N.B. Lookup: (The name of the Lookups class from which permitted values must be taken)
*RiskId[string]Id of the Quote/Risk object.
*QuoteId[string]Id of the Quote object.
*Documents[string]List of documents to create. Lookup: Documents
*CorrespondenceAddressDifferent[boolean]Indicates whether the correspondence address is different from the insured address.
CorrespondenceAddress1[string] (Max 50)The correspondence address line 1 of the applicant.
CorrespondenceAddress2[string] (Max 50)The correspondence address line 2 of the applicant.
CorrespondenceAddress3[string] (Max 50)The correspondence address line 3 of the applicant.
CorrespondenceAddress4[string] (Max 50)The correspondence address line 4 of the applicant.
CorrespondenceAddress5[string] (Max 50)The correspondence address line 5 of the applicant.
CorrespondencePostcode[string] (Max 8)The correspondence address post code of the applicant.
CorrespondenceAddressValidUntil[datetime]Indicates that the correspondence address is valid until the specified date.
CorrespondenceAddressInTheUK[string]Indicates whether the correspondence address is in the UK.
*DaytimeTelephone[string] (Max 20)Daytime Telephone.
*EveningTelephone[string] (Max 20)Evening Telephone.
*InsuredAddress1[string] (Max 50)The insured address line 1 of the property.
InsuredAddress2[string] (Max 50)The insured address line 2 of the property.
InsuredAddress3[string] (Max 50)The insured address line 3 of the property.
InsuredAddress4[string] (Max 50)The insured address line 4 of the property.
InsuredAddress5[string] (Max 50)The insured address line 5 of the property.
MortgageLenderName[string] (Max 70)The mortgage lender name.
*ComplianceAdviceOffered[boolean]Indicates whether an advice have been offered.
*ComplianceDemandsAndNeedsMet[boolean]Indicates whether the client have been informed about any parts of the cover which do not apply.
ComplianceDemandsAndNeedsComments[string]The list of any demand and needs which are not met in the policy.
*ComplianceServiceFee[decimal]The service fee amount.
*ComplianceCommissionDisclosure[boolean]Indicates whether to disclose the commission to the customer.
*BrokerUsername[string]The broker username.
POST https://api.thesource.co.uk/api/documents HTTP/1.1
HTTP/1.1 200 (OK)
{
"QuoteId": "59255b8c7f710741546fab27",
"RiskId": "59255b887f710741546fab26",
"Documents" : [ "Statement of Demands and Needs", "Statement of Price", "Initial Disclosure" ],
"CorrespondenceAddressDifferent" : false,
"DaytimeTelephone": "02920265265",
"EveningTelephone": "02920265265",
"InsuredAddress1": "Insured Address Line One",
"MortgageLenderName": "Admiral Insurance",
"ComplianceAdviceOffered": true,
"ComplianceDemandsAndNeedsMet": true,
"ComplianceServiceFee": 45,
"ComplianceCommissionDisclosure": true,
"ComplianceDemandsAndNeedsComments": "Notes",
"BrokerUsername" : "John Doe"
}
Submission objects hold the results of insurance submission
RiskId[string]The Id of the Risk.
QuoteResultId[string]The Id of the QuoteResult.
SubmissionDateTime[datetime]The DateTime of the submission.
Status[string]The Status of the submission.
ClientId[string]The client id.
TransId[string]The transaction id.
OtherInfo[string]Other info.
Relative endpoint: GET /submissions?id=5576ace367233b0b90e88a17&brokerId=72351
You must supply a X-Broker-Authentication header with the broker's username and password.
idId of the Quote/Risk record containing the QuoteResults.
brokerIdThe id of the broker.
GET https://api.thesource.co.uk/api/quotes?id=5540d96741044a147cef8f24 HTTP/1.1
HTTP/1.1 200 (OK)
{
{
"RiskId": "5582eb9b67235437e0b57cb8",
"QuoteResultId": "5582eb9b67235437e0b57cb9",
"Status": "Successful",
"SubmissionDateTime": "2015-02-04T14:34:23Z",
"IsisResult": "ok",
"SkyFireResult": "1010",
"ClientId": "i161687",
"TransId": "i495805",
"OtherInfo": "Submission Successful"
}
}
Relative endpoint: POST /submissions
You must supply a X-Broker-Authentication header with the broker's username and password.
N.B. Lookup: (The name of the Lookups class from which permitted values must be taken)
*Delegated[boolean]Indicates if the call is delegated (i.e. to be retrieved later).
*RiskId[string]Id of the Quote/Risk object.
*QuoteResultId[string]Id of the QuoteResult object.
*InceptionDate[date]The date that the policy will start from.
*CorrespondenceAddressDifferent[boolean]Indicates whether the correspondence address is different from the insured address.
CorrespondenceAddress1[string] (Max 50)The correspondence address line 1 of the applicant.
CorrespondenceAddress2[string] (Max 50)The correspondence address line 2 of the applicant.
CorrespondenceAddress3[string] (Max 50)The correspondence address line 3 of the applicant.
CorrespondenceAddress4[string] (Max 50)The correspondence address line 4 of the applicant.
CorrespondenceAddress5[string] (Max 50)The correspondence address line 5 of the applicant.
CorrespondencePostcode[string] (Max 8)The correspondence address post code of the applicant.
CorrespondenceAddressValidUntil[date]Indicates that the correspondence address is valid until the specified date.
CorrespondenceAddressInTheUK[boolean]Indicates whether the correspondence address is in the UK.
*DaytimeTelephone[string] (Max 20)Daytime Telephone.
*EveningTelephone[string] (Max 20)Evening Telephone.
*InsuredAddress1[string] (Max 50)The insured address line 1 of the property.
InsuredAddress2[string] (Max 50)The insured address line 2 of the property.
InsuredAddress3[string] (Max 50)The insured address line 3 of the property.
InsuredAddress4[string] (Max 50)The insured address line 4 of the property.
InsuredAddress5[string] (Max 50)The insured address line 5 of the property.
MortgageLenderName[string] (Max 70)The mortgage lender name.
*PaymentMethod[string]The payment method.
DirectDebit[string]The direct debit object that holds the direct debit details (only required if PaymentMethod is Direct Debit)
*BrokerUsername[string]The broker username.
*ConfirmationEmail[string]The main confirmation cover email address.
ConfirmationEmailCC[string]The list of email addresses that require a carbon copy, split by semi-colons.
AdditionalNotes[string]Additional Notes.
ReferralSubmissionCode[string]The referral submission code.
*ComplianceAdviceOffered[boolean]Indicates whether an advice have been offered.
ComplianceDemandsAndNeedsMet[boolean]Indicates whether the client have been informed about any parts of the cover which do not apply.
ComplianceDemandsAndNeedsComments[string]The list of any demand and needs which are not met in the policy.
*ComplianceServiceFee[decimal]The service fee amount.
*ComplianceCommissionDisclosure[boolean]Indicates whether to disclose the commission to the customer.
IsAutoRenewal[boolean]Indicates whether to automatically renew a policy.
PayerName[string]The payer name.
DDBankSortCode[string]The bank sort code.
DDBankAccountNo[string]The bank account number.
DDBankCollectionDay[integer]The bank sort code.
CreditAgreementSigned[boolean]The bank account number.
POST https://api.thesource.co.uk/api/submissions HTTP/1.1
{
"Delegated": false,
"RiskId": "5582eb9a67235437e0b57cb8",
"QuoteResultId": "5582eb9b67235437e0b57cb9",
"InceptionDate" : "2015-07-12",
"CorrespondenceAddressDifferent": true,
"CorrespondenceAddress1": "Drake House",
"CorrespondenceAddress2": "Plymouth Road",
"CorrespondenceAddress3": "Penarth",
"CorrespondenceAddress4": "Vale of Glamorgan",
"CorrespondenceAddress5": "",
"CorrespondencePostcode": "CF64 3TP",
"CorrespondenceAddressValidUntil": "2020-12-01",
"CorrespondenceAddressInTheUK": false,
"DaytimeTelephone": "02920265265",
"EveningTelephone": "02920265265",
"InsuredAddress1": "22 Sarn Hill",
"InsuredAddress2": "Sarn",
"InsuredAddress3": "",
"InsuredAddress4": "",
"InsuredAddress5": "",
"MortgageLenderName": "Admiral Insurance",
"PaymentMethod": "Direct Debit",
"DirectDebit": {
"PayerName": "John Doe",
"DDBankSortCode": "12-13-14",
"DDBankAccountNo": "12345678",
"DDBankCollectionDay": "1",
"CreditAgreementSigned": true
},
"BrokerUsername": "Test CD",
"ConfirmationEmail": "[email protected]",
"ConfirmationEmailCC": "[email protected]",
"AdditionalNotes": "Additional notes...",
"ReferralSubmissionCode": "24887",
"ComplianceAdviceOffered": true,
"ComplianceDemandsAndNeedsMet": true,
"ComplianceDemandsAndNeedsComments": "Demand and needs comments...",
"ComplianceServiceFee": "60",
"ComplianceCommissionDisclosure": false,
"IsAutoRenewal": true
}
Allows an insurance aggregator to send performance details regarding a single quote result.
Relative endpoint: POST /topx
You must supply a X-Broker-Authentication header with the broker's username and password.
*QuoteResultId[string]Id of the QuoteResult object.
RiskId[string]Id of the Quote/Risk object.
*Position[int]Position of the supplied quote result in relation to other quote results.
*TopPremium[decimal]Premium of the cheapest quote result.
POST https://api.thesource.co.uk/api/TopX HTTP/1.1
{
"QuoteResultId": "591d75f3d8ba1015187833f8",
"RiskId": "591d75edd8ba1015187833f7",
"Position": 2,
"TopPremium": 183.81
}