Full-risk API reference: Re:New Broking

Re:New Car Insurance Webservice v2.0.0

Submit a car insurance quote request

POST/car-insurance/webservice/quote/json/

API for submitting motor insurance quote requests to the Re:New Broking aggregation platform. Occupation codes follow standard ABI List 55. Industry/business codes follow ABI List 11. Conviction codes follow ABI List 24. Vehicle make and model are derived from the ABI code and do not need to be submitted separately.

Submits a full motor insurance risk to the Re:New panel aggregator and returns panel quotes for the supplied risk.

Test environment: https://renewbroking-test.sostec.co.uk
Production environment: https://renewbroking.sostec.co.uk
Authentication: None in headers. The caller is identified by an id in the body, which the portal sets for you.

Request body

application/json, required

quoteobjectrequired

affiliate_idintegerrequired

Affiliate ID assigned by your account manager

Example 1

sourcestringoptional

Source identifier for tracking the origin of the quote

Example ogi-refer

s1stringoptional

Additional tracking variable (e.g. policy reference)

Example ANCX11PC01

your_detailsobjectrequired

titlestringrequired

Proposer's title

Example MR

Allowed values
`MR`
`MRS`
`MS`
`MISS`

first_namestringrequired

Proposer's first name

Example Chris

surnamestringrequired

Proposer's surname

Example Anthony

dobstring (date)required

Date of birth (YYYY-MM-DD)

Example 1990-04-03

marital_statusstringrequired

Marital status: M = Married, S = Single, P = Common Law Partnered/Cohabiting, D = Divorced/Dissolved, A = Separated, W = Widowed/Surviving Civil Partner, B = Civil Partnered

Example M

Allowed values
`M`	Married
`S`	Single
`P`	Common Law Partnered/Cohabiting
`D`	Divorced/Dissolved
`A`	Separated
`W`	Widowed/Surviving Civil Partner
`B`	Civil Partnered

emp_statusstringrequired

Employment status: E = Employed, H = Houseperson, F = Full/Part-time education, S = Self-employed, R = Retired, U = Unemployed, N = Not employed due to disability/illness

Example E

Allowed values
`E`	Employed
`H`	Houseperson
`F`	Full/Part-time education
`S`	Self-employed
`R`	Retired
`U`	Unemployed
`N`	Not employed due to disability/illness

occupationstringrequired

Occupation code from ABI List 55. Pass the standard ABI numeric code as a string.

Example 621

industrystringrequired

Industry/business code from ABI List 11. Pass the standard ABI numeric code as a string.

Example 561

postcodestringrequired

Proposer's home postcode

Example PR2 6UJ

address_1stringrequired

Address line 1

Example 7 Ingleton Road

address_2stringoptional

Address line 2

Example Ribbleton

citystringrequired

City

Example Preston

countystringrequired

County

Example Lancashire

vehicle_addressbooleanrequired

Is the vehicle kept at the proposer's home address?

Example true

email_addressstring (email)required

Contact email address

Example chris@example.com

contact_numberstringrequired

Contact telephone number. If not provided, defaults to 01000 000000.

Example 01234567890

how_paystringrequired

Preferred payment frequency: M = Monthly, F = In-full (annually)

Example F

Allowed values
`M`	Monthly
`F`	In-full (annually)

home_ownerbooleanrequired

Does the proposer own their home?

Example false

children_under_16booleanrequired

Does the proposer have any children under 16?

Example false

household_vehiclesintegerrequired

Total number of vehicles in the household, including this one

1 to 9

Example 1

uk_resident_since_dobbooleanrequired

Has the proposer been a permanent UK resident since birth? If false, uk_resident_since must be provided.

Example true

uk_resident_sincestring (date)optional

Date the proposer became a permanent UK resident (YYYY-MM-DD). Required when uk_resident_since_dob is false.

Example 2005-06-01

licence_typestringrequired

Driving licence type: F = Full UK Car Licence, FA = Full UK Car Licence (automatic only), P = Provisional UK Car Licence, E = Full EU Licence, H = Full European non-EU Licence, N = Full International Licence

Example F

Allowed values
`F`	Full UK Car Licence
`FA`	Full UK Car Licence (automatic only)
`P`	Provisional UK Car Licence
`E`	Full EU Licence
`H`	Full European non-EU Licence
`N`	Full International Licence

licence_numberstringoptional

Driving licence number (optional)

Example ANTHO904031CA9TB

licence_yearsintegerrequired

Number of years the licence has been held. 0 = less than 1 year (licence_date must then be provided). 25 = 25 years or more.

0 to 25

Example 14

licence_datestring (date)optional

Date the licence was obtained (YYYY-MM-DD). Required when licence_years = 0 (less than 1 year).

Example 2023-09-15

driving_qualificationstringrequired

Advanced driving qualification held (if any): DQN = None, DQA = AA Proficiency, DQI = Institute of Advanced Motorists (IAM), DQP = Pass Plus

Example DQN

Allowed values
`DQN`	None
`DQA`	AA Proficiency
`DQI`	Institute of Advanced Motorists (IAM)
`DQP`	Pass Plus

driving_qualification_datestring (date)optional

Date the driving qualification was obtained (YYYY-MM-DD). Required when driving_qualification is not DQN.

Example 2018-04-01

use_other_vehiclesstringrequired

Use of other vehicles: XVE = No access to any other cars, 1VE = Own another car or van, UVE = Have use of another car, COVE = Company car (including personal use), CXVE = Company car (excluding personal use)

Example XVE

Allowed values
`XVE`	No access to any other cars
`1VE`	Own another car or van
`UVE`	Have use of another car
`COVE`	Company car (including personal use)
`CXVE`	Company car (excluding personal use)

non_motoring_convictionsbooleanrequired

Does the proposer have any non-motoring criminal convictions?

Example false

dvla_medical_conditionstringrequired

Medical conditions or disabilities that must be reported to the DVLA: DVN = No medical conditions, DVR = DVLA aware – No restrictions, DV1 = DVLA aware – 1 year restricted licence, DV2 = DVLA aware – 2 year restricted licence, DV3 = DVLA aware – 3 year restricted licence, DVU = DVLA unaware

Example DVN

Allowed values
`DVN`	No medical conditions
`DVR`	DVLA aware – No restrictions
`DV1`	DVLA aware – 1 year restricted licence
`DV2`	DVLA aware – 2 year restricted licence
`DV3`	DVLA aware – 3 year restricted licence
`DVU`	DVLA unaware

vehicle_usagestringrequired

Primary use of the vehicle: 02YN = Social, Domestic, Pleasure and Commuting (SDPC), 05NN = Social, Domestic and Pleasure only (SDP), 15YY = SDPC and Business use (proposer only), 11YY = SDPC and Business use (proposer/spouse only), 12YY = SDPC and Business use (any named driver)

Example 02YN

Allowed values
`02YN`	Social, Domestic, Pleasure and Commuting (SDPC)
`05NN`	Social, Domestic and Pleasure only (SDP)
`15YY`	SDPC and Business use (proposer only)
`11YY`	SDPC and Business use (proposer/spouse only)
`12YY`	SDPC and Business use (any named driver)

mileageintegerrequired

Estimated annual private mileage

Example 9000

business_mileageintegeroptional

Estimated annual business mileage. Required when vehicle_usage is 15YY, 11YY or 12YY.

Example 5000

insurance_cancelledbooleanrequired

Has the proposer (or any named driver) ever had an insurance policy declined, cancelled, voided, or had special terms imposed?

Example false

claimsarray of objectoptional

Motor accidents or claims in the last 5 years

[item]objectoptional

claim_typestringrequired

Type of claim: A = Accident, T = Theft of Vehicle, M = Theft Related Damage, V = Malicious Damage, W = Windscreen Only, F = Fire Damage, 1 = Theft – Sound Equipment, 2 = Theft – Personal Effects, 3 = Theft – Accessories, S = Storm Damage, 4 = Riot Damage, 5 = Lightning Damage, 6 = Explosion

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

convictionsarray of objectoptional

Motoring convictions, fixed penalties or disqualifications (including pending)

[item]objectoptional

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

additional_driversarray of objectoptional

Up to 5 additional named drivers

at most 5

[item]objectoptional

relationshipstringrequired

Relationship to proposer: S = Spouse, W = Common Law Partner/Cohabitee, O = Son/Daughter, M = Parent, F = Other Family, E = Employee, B = Employer, C = Business Partner, U = Other, R = Brother/Sister, J = Civil Partner

Example W

Allowed values
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Business Partner
`U`	Other
`R`	Brother/Sister
`J`	Civil Partner

titlestringrequired

Example MISS

Allowed values
`MR`
`MRS`
`MS`
`MISS`

first_namestringrequired

Example Jayne

surnamestringrequired

Example Smith

dobstring (date)required

Date of birth (YYYY-MM-DD)

Example 1991-02-01

marital_statusstringrequired

M = Married, S = Single, P = Common Law Partnered/Cohabiting, D = Divorced/Dissolved, A = Separated, W = Widowed/Surviving Civil Partner, B = Civil Partnered

Example S

Allowed values
`M`	Married
`S`	Single
`P`	Common Law Partnered/Cohabiting
`D`	Divorced/Dissolved
`A`	Separated
`W`	Widowed/Surviving Civil Partner
`B`	Civil Partnered

emp_statusstringrequired

E = Employed, H = Houseperson, F = Full/Part-time education, S = Self-employed, R = Retired, U = Unemployed, N = Not employed due to disability/illness

Example E

Allowed values
`E`	Employed
`H`	Houseperson
`F`	Full/Part-time education
`S`	Self-employed
`R`	Retired
`U`	Unemployed
`N`	Not employed due to disability/illness

occupationstringrequired

Occupation code from ABI List 55

Example 114

industrystringrequired

Industry/business code from ABI List 11

Example 620

uk_resident_since_dobbooleanrequired

Has the driver been a permanent UK resident since birth? If false, uk_resident_since must be provided.

Example true

uk_resident_sincestring (date)optional

Date the driver became a permanent UK resident (YYYY-MM-DD). Required when uk_resident_since_dob is false.

Example 2005-06-01

licence_typestringrequired

F = Full UK Car Licence, FA = Full UK (automatic only), P = Provisional UK, E = Full EU, H = Full European non-EU, N = Full International

Example F

Allowed values
`F`	Full UK Car Licence
`FA`	Full UK (automatic only)
`P`	Provisional UK
`E`	Full EU
`H`	Full European non-EU
`N`	Full International

licence_numberstringoptional

Driving licence number (optional)

Example

licence_yearsintegerrequired

Years the licence has been held. 0 = less than 1 year; 25 = 25+.

0 to 25

Example 15

licence_datestring (date)optional

Date licence was obtained (YYYY-MM-DD). Required when licence_years = 0.

Example 2023-09-15

driving_qualificationstringrequired

DQN = None, DQA = AA Proficiency, DQI = IAM, DQP = Pass Plus

Example DQN

Allowed values
`DQN`	None
`DQA`	AA Proficiency
`DQI`	IAM
`DQP`	Pass Plus

driving_qualification_datestring (date)optional

Date the driving qualification was obtained (YYYY-MM-DD). Required when driving_qualification is not DQN.

Example 2018-04-01

use_other_vehiclesstringrequired

XVE = No access to other cars, 1VE = Own another car/van, UVE = Have use of another car, COVE = Company car (incl. personal), CXVE = Company car (excl. personal)

Example XVE

Allowed values
`XVE`	No access to other cars
`1VE`	Own another car/van
`UVE`	Have use of another car
`COVE`	Company car (incl. personal)
`CXVE`	Company car (excl. personal)

non_motoring_convictionsbooleanrequired

Example false

dvla_medical_conditionstringrequired

DVN = No conditions, DVR = DVLA aware (no restrictions), DV1 = DVLA aware (1-year restricted), DV2 = DVLA aware (2-year restricted), DV3 = DVLA aware (3-year restricted), DVU = DVLA unaware

Example DVN

Allowed values
`DVN`	No conditions
`DVR`	DVLA aware (no restrictions)
`DV1`	DVLA aware (1-year restricted)
`DV2`	DVLA aware (2-year restricted)
`DV3`	DVLA aware (3-year restricted)
`DVU`	DVLA unaware

vehicle_usagestringrequired

02YN = SDPC, 05NN = SDP, 15YY = SDPC + Business (proposer only), 11YY = SDPC + Business (proposer/spouse), 12YY = SDPC + Business (any named driver)

Example 02YN

Allowed values
`02YN`	SDPC
`05NN`	SDP
`15YY`	SDPC + Business (proposer only)
`11YY`	SDPC + Business (proposer/spouse)
`12YY`	SDPC + Business (any named driver)

insurance_cancelledbooleanrequired

Example false

claimsarray of objectoptional

[item]objectoptional

claim_typestringrequired

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

convictionsarray of objectoptional

[item]objectoptional

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

your_coverobjectrequired

registration_numberstringrequired

Vehicle registration number

Example BV63GHJ

abi_codestringrequired

ABI code for the vehicle. Make and model are derived from this code by the platform and do not need to be submitted separately.

Example 35690305

engine_sizestringrequired

Engine displacement in cc

Example 1598

year_of_manufacturerstringrequired

Year of manufacture (YYYY)

pattern ^\d{4}$

Example 2013

transmissionstringrequired

Manual = Manual gearbox, Auto = Automatic gearbox

Example Manual

Allowed values
`Manual`	Manual gearbox
`Auto`	Automatic gearbox

left_hand_drivebooleanrequired

true = Left hand drive, false = Right hand drive

Example false

no_seatsstringrequired

Number of seats in the vehicle

Example 5

doorsstringrequired

Number of doors on the vehicle

Example 4

alarm_immobiliserstringrequired

Alarm/immobiliser fitted to the vehicle: #N = None, #F = Factory Fitted (unspecified), 99991 = Factory Fitted Thatcham Approved Alarm/Immobiliser, 99992 = Factory Fitted Thatcham Approved Alarm only, 99993 = Factory Fitted Non-Thatcham Alarm/Immobiliser, 99994 = Factory Fitted Non-Thatcham Alarm only

Example 99991

Allowed values
`#N`	None
`#F`	Factory Fitted (unspecified)
`99991`	Factory Fitted Thatcham Approved Alarm/Immobiliser
`99992`	Factory Fitted Thatcham Approved Alarm only
`99993`	Factory Fitted Non-Thatcham Alarm/Immobiliser
`99994`	Factory Fitted Non-Thatcham Alarm only

tracking_devicebooleanrequired

Is a tracking device fitted to the vehicle?

Example false

vehicle_valuenumberrequired

Current market value of the vehicle in GBP. Derived from CDL lookup where available; otherwise entered by the customer.

Example 22500

modifiedbooleanrequired

Has the vehicle been modified or adapted from standard? If true, the modifications array must be populated.

Example false

modificationsarray of objectoptional

List of modifications made to the vehicle. Required when modified is true. Codes are from the standard Modifications reference list.

[item]objectoptional

modification_typestringrequired

Modification type code from ABI List 86. Pass the standard ABI numeric code as a string.

Example 1

vehicle_importedbooleanrequired

Is the vehicle an import?

Example false

registered_ownerstringrequired

Legal owner of the vehicle: P = Proposer (policyholder), S = Spouse, W = Common Law Partner/Cohabitee, O = Son/Daughter, M = Parent, F = Other Family, E = Employee, B = Employer, C = Company/Business Partner, U = Other, R = Brother/Sister or Leased Private, J = Civil Partner, L = Leased Company

Example P

Allowed values
`P`	Proposer (policyholder)
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Company/Business Partner
`U`	Other
`R`	Brother/Sister or Leased Private
`J`	Civil Partner
`L`	Leased Company

registered_keeperstringrequired

Registered keeper of the vehicle: P = Proposer (policyholder), S = Spouse, W = Common Law Partner/Cohabitee, O = Son/Daughter, M = Parent, F = Other Family, E = Employee, B = Employer, C = Company/Business Partner, U = Other/Society or Club, R = Brother/Sister or Leased Private, J = Civil Partner, L = Leased Company

Example P

Allowed values
`P`	Proposer (policyholder)
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Company/Business Partner
`U`	Other/Society or Club
`R`	Brother/Sister or Leased Private
`J`	Civil Partner
`L`	Leased Company

main_driverstringrequired

Reference ID of the main driver of the vehicle. Use "1" for the proposer, or the index of an additional driver (e.g. "2" for the first additional driver).

Example 1

purchase_datestring (date)optional

Date the vehicle was purchased (YYYY-MM-DD)

Example 2022-11-21

purchase_pricenumberrequired

Purchase price of the vehicle in GBP

Example 20000

vehicle_not_yet_purchasedbooleanrequired

Set to true if the vehicle has not yet been purchased. When true, purchase_date should be omitted.

Example false

vehicle_kept_at_main_addressbooleanrequired

Is the vehicle kept at the proposer's main address? If false, vehicle_kept_postcode and vehicle_kept_house_number must be provided.

Example true

vehicle_kept_postcodestringoptional

Postcode where the vehicle is kept, if different from the proposer's main address. Required when vehicle_kept_at_main_address is false.

Example M1 1AA

vehicle_kept_house_numberstringoptional

House number or name where the vehicle is kept, if different from the proposer's main address. Required when vehicle_kept_at_main_address is false.

Example 42

vehicle_daytime_locationstringoptional

Where the vehicle is kept during the day: VKD1 = At home address, VKD2 = Office or factory car park, VKD3 = Open public car park, VKD4 = Secure public car park, VKD5 = Street away from home

Example VKD1

Allowed values
`VKD1`	At home address
`VKD2`	Office or factory car park
`VKD3`	Open public car park
`VKD4`	Secure public car park
`VKD5`	Street away from home

overnight_parkingstringrequired

Where the vehicle is kept overnight: 2 = Private property, 4 = Drive, 7 = Locked compound, 10 = Locked garage, 11 = Unlocked garage, 12 = Street outside home, 13 = Street away from home, 14 = Public car park, 15 = Work car park

Example 10

Allowed values
`2`	Private property
`4`	Drive
`7`	Locked compound
`10`	Locked garage
`11`	Unlocked garage
`12`	Street outside home
`13`	Street away from home
`14`	Public car park
`15`	Work car park

inception_datestring (date)required

Desired cover start date (YYYY-MM-DD)

Example 2026-11-22

cover_typestringrequired

Level of cover: 01 = Comprehensive, 02 = Third Party, Fire and Theft, 03 = Third Party Only

Example 01

Allowed values
`01`	Comprehensive
`02`	Third Party, Fire and Theft
`03`	Third Party Only

vol_xsintegerrequired

Voluntary excess amount in GBP

Example 250

Allowed values
`0`
`50`
`100`
`150`
`200`
`250`
`300`
`350`
`400`
`450`
`500`
`600`
`700`
`800`
`900`
`1000`

ncbintegerrequired

No Claims Discount years (0–20, where 20 represents 20 or more)

0 to 20

Example 5

ncd_sourcestringoptional

Source of No Claims Discount (asked when ncb > 0): 1 = This vehicle or a previous vehicle, 3 = Company vehicle, 4 = Foreign insurer

Example 1

Allowed values
`1`	This vehicle or a previous vehicle
`3`	Company vehicle
`4`	Foreign insurer

protected_ncdbooleanrequired

Is the No Claims Discount protected?

Example false

named_driver_experiencestringoptional

Named driver experience type (asked when ncb = 0 and proposer is over 18): NDN = None, NDA = Named driver on another car, NDI = Named driver on a company car (including personal use), NDE = Named driver on a company car (excluding personal use)

Example NDN

Allowed values
`NDN`	None
`NDA`	Named driver on another car
`NDI`	Named driver on a company car (including personal use)
`NDE`	Named driver on a company car (excluding personal use)

named_driver_experience_yearsstringoptional

Years of claim-free named driver experience (asked when named_driver_experience is not NDN): NDY0 = 0 years, NDY1 = 1 year, ... NDY15 = 15 years or more

Example NDY3

Allowed values
`NDY0`	0 years
`NDY1`	1 year
`NDY2`
`NDY3`
`NDY4`
`NDY5`
`NDY6`
`NDY7`
`NDY8`
`NDY9`
`NDY10`
`NDY11`
`NDY12`
`NDY13`
`NDY14`
`NDY15`	15 years or more

Responses

200Quote response returned successfully

Array of quote results from the Re:New panel aggregator. Each item represents a quote from a panel provider.

[item]objectoptional

quote_idstringoptional

Unique identifier for this individual quote

Example 42

statusstringoptional

Status of the quote (e.g. Complete, Failed, Referred)

Example Complete

pricestringoptional

Quoted premium in GBP

Example 251.28

brand_namestringoptional

Brand name of the quoting provider

Example GotYouCovered

product_namestringoptional

Product name for the quote

Example GotYouCovered

referencestringoptional

Provider's unique reference for this quote

Example UGYCAPI-C3D003D10W

deeplinkstring (uri)optional

Direct URL for the customer to view/purchase this quote

Example http://gotyoucovered-test.sostec.co.uk/car-insurance/webservice/deeplink/?quote_id=42&email=&results_id=20

Example 200 response

[
  {
    "quote_id": "42",
    "status": "Complete",
    "price": "251.28",
    "brand_name": "GotYouCovered",
    "product_name": "GotYouCovered",
    "reference": "UGYCAPI-C3D003D10W",
    "deeplink": "http://gotyoucovered-test.sostec.co.uk/car-insurance/webservice/deeplink/?quote_id=42&email=&results_id=20"
  }
]

400Bad request — validation error in submitted data

successbooleanoptional

Example false

error_codestringoptional

Example VALIDATION_ERROR

messagestringoptional

Example Required field 'dob' is missing

fieldsarray of stringoptional

List of fields that failed validation

Example 400 response

{
  "success": false,
  "error_code": "VALIDATION_ERROR",
  "message": "Required field 'dob' is missing",
  "fields": [
    "dob",
    "postcode"
  ]
}

401Unauthorised — invalid or missing affiliate credentials

successbooleanoptional

Example false

error_codestringoptional

Example VALIDATION_ERROR

messagestringoptional

Example Required field 'dob' is missing

fieldsarray of stringoptional

List of fields that failed validation

Example 401 response

{
  "success": false,
  "error_code": "VALIDATION_ERROR",
  "message": "Required field 'dob' is missing",
  "fields": [
    "dob",
    "postcode"
  ]
}

500Internal server error

successbooleanoptional

Example false

error_codestringoptional

Example VALIDATION_ERROR

messagestringoptional

Example Required field 'dob' is missing

fieldsarray of stringoptional

List of fields that failed validation

Example 500 response

{
  "success": false,
  "error_code": "VALIDATION_ERROR",
  "message": "Required field 'dob' is missing",
  "fields": [
    "dob",
    "postcode"
  ]
}

Schemas

`CarQuoteRequest`

quoteobjectrequired

affiliate_idintegerrequired

Affiliate ID assigned by your account manager

Example 1

sourcestringoptional

Source identifier for tracking the origin of the quote

Example ogi-refer

s1stringoptional

Additional tracking variable (e.g. policy reference)

Example ANCX11PC01

your_detailsobjectrequired

titlestringrequired

Proposer's title

Example MR

Allowed values
`MR`
`MRS`
`MS`
`MISS`

first_namestringrequired

Proposer's first name

Example Chris

surnamestringrequired

Proposer's surname

Example Anthony

dobstring (date)required

Date of birth (YYYY-MM-DD)

Example 1990-04-03

marital_statusstringrequired

Marital status: M = Married, S = Single, P = Common Law Partnered/Cohabiting, D = Divorced/Dissolved, A = Separated, W = Widowed/Surviving Civil Partner, B = Civil Partnered

Example M

Allowed values
`M`	Married
`S`	Single
`P`	Common Law Partnered/Cohabiting
`D`	Divorced/Dissolved
`A`	Separated
`W`	Widowed/Surviving Civil Partner
`B`	Civil Partnered

emp_statusstringrequired

Employment status: E = Employed, H = Houseperson, F = Full/Part-time education, S = Self-employed, R = Retired, U = Unemployed, N = Not employed due to disability/illness

Example E

Allowed values
`E`	Employed
`H`	Houseperson
`F`	Full/Part-time education
`S`	Self-employed
`R`	Retired
`U`	Unemployed
`N`	Not employed due to disability/illness

occupationstringrequired

Occupation code from ABI List 55. Pass the standard ABI numeric code as a string.

Example 621

industrystringrequired

Industry/business code from ABI List 11. Pass the standard ABI numeric code as a string.

Example 561

postcodestringrequired

Proposer's home postcode

Example PR2 6UJ

address_1stringrequired

Address line 1

Example 7 Ingleton Road

address_2stringoptional

Address line 2

Example Ribbleton

citystringrequired

City

Example Preston

countystringrequired

County

Example Lancashire

vehicle_addressbooleanrequired

Is the vehicle kept at the proposer's home address?

Example true

email_addressstring (email)required

Contact email address

Example chris@example.com

contact_numberstringrequired

Contact telephone number. If not provided, defaults to 01000 000000.

Example 01234567890

how_paystringrequired

Preferred payment frequency: M = Monthly, F = In-full (annually)

Example F

Allowed values
`M`	Monthly
`F`	In-full (annually)

home_ownerbooleanrequired

Does the proposer own their home?

Example false

children_under_16booleanrequired

Does the proposer have any children under 16?

Example false

household_vehiclesintegerrequired

Total number of vehicles in the household, including this one

1 to 9

Example 1

uk_resident_since_dobbooleanrequired

Has the proposer been a permanent UK resident since birth? If false, uk_resident_since must be provided.

Example true

uk_resident_sincestring (date)optional

Date the proposer became a permanent UK resident (YYYY-MM-DD). Required when uk_resident_since_dob is false.

Example 2005-06-01

licence_typestringrequired

Example F

Allowed values
`F`	Full UK Car Licence
`FA`	Full UK Car Licence (automatic only)
`P`	Provisional UK Car Licence
`E`	Full EU Licence
`H`	Full European non-EU Licence
`N`	Full International Licence

licence_numberstringoptional

Driving licence number (optional)

Example ANTHO904031CA9TB

licence_yearsintegerrequired

Number of years the licence has been held. 0 = less than 1 year (licence_date must then be provided). 25 = 25 years or more.

0 to 25

Example 14

licence_datestring (date)optional

Date the licence was obtained (YYYY-MM-DD). Required when licence_years = 0 (less than 1 year).

Example 2023-09-15

driving_qualificationstringrequired

Advanced driving qualification held (if any): DQN = None, DQA = AA Proficiency, DQI = Institute of Advanced Motorists (IAM), DQP = Pass Plus

Example DQN

Allowed values
`DQN`	None
`DQA`	AA Proficiency
`DQI`	Institute of Advanced Motorists (IAM)
`DQP`	Pass Plus

driving_qualification_datestring (date)optional

Date the driving qualification was obtained (YYYY-MM-DD). Required when driving_qualification is not DQN.

Example 2018-04-01

use_other_vehiclesstringrequired

Example XVE

Allowed values
`XVE`	No access to any other cars
`1VE`	Own another car or van
`UVE`	Have use of another car
`COVE`	Company car (including personal use)
`CXVE`	Company car (excluding personal use)

non_motoring_convictionsbooleanrequired

Does the proposer have any non-motoring criminal convictions?

Example false

dvla_medical_conditionstringrequired

Example DVN

Allowed values
`DVN`	No medical conditions
`DVR`	DVLA aware – No restrictions
`DV1`	DVLA aware – 1 year restricted licence
`DV2`	DVLA aware – 2 year restricted licence
`DV3`	DVLA aware – 3 year restricted licence
`DVU`	DVLA unaware

vehicle_usagestringrequired

Example 02YN

Allowed values
`02YN`	Social, Domestic, Pleasure and Commuting (SDPC)
`05NN`	Social, Domestic and Pleasure only (SDP)
`15YY`	SDPC and Business use (proposer only)
`11YY`	SDPC and Business use (proposer/spouse only)
`12YY`	SDPC and Business use (any named driver)

mileageintegerrequired

Estimated annual private mileage

Example 9000

business_mileageintegeroptional

Estimated annual business mileage. Required when vehicle_usage is 15YY, 11YY or 12YY.

Example 5000

insurance_cancelledbooleanrequired

Has the proposer (or any named driver) ever had an insurance policy declined, cancelled, voided, or had special terms imposed?

Example false

claimsarray of objectoptional

Motor accidents or claims in the last 5 years

[item]objectoptional

claim_typestringrequired

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

convictionsarray of objectoptional

Motoring convictions, fixed penalties or disqualifications (including pending)

[item]objectoptional

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

additional_driversarray of objectoptional

Up to 5 additional named drivers

at most 5

[item]objectoptional

relationshipstringrequired

Example W

Allowed values
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Business Partner
`U`	Other
`R`	Brother/Sister
`J`	Civil Partner

titlestringrequired

Example MISS

Allowed values
`MR`
`MRS`
`MS`
`MISS`

first_namestringrequired

Example Jayne

surnamestringrequired

Example Smith

dobstring (date)required

Date of birth (YYYY-MM-DD)

Example 1991-02-01

marital_statusstringrequired

M = Married, S = Single, P = Common Law Partnered/Cohabiting, D = Divorced/Dissolved, A = Separated, W = Widowed/Surviving Civil Partner, B = Civil Partnered

Example S

Allowed values
`M`	Married
`S`	Single
`P`	Common Law Partnered/Cohabiting
`D`	Divorced/Dissolved
`A`	Separated
`W`	Widowed/Surviving Civil Partner
`B`	Civil Partnered

emp_statusstringrequired

E = Employed, H = Houseperson, F = Full/Part-time education, S = Self-employed, R = Retired, U = Unemployed, N = Not employed due to disability/illness

Example E

Allowed values
`E`	Employed
`H`	Houseperson
`F`	Full/Part-time education
`S`	Self-employed
`R`	Retired
`U`	Unemployed
`N`	Not employed due to disability/illness

occupationstringrequired

Occupation code from ABI List 55

Example 114

industrystringrequired

Industry/business code from ABI List 11

Example 620

uk_resident_since_dobbooleanrequired

Has the driver been a permanent UK resident since birth? If false, uk_resident_since must be provided.

Example true

uk_resident_sincestring (date)optional

Date the driver became a permanent UK resident (YYYY-MM-DD). Required when uk_resident_since_dob is false.

Example 2005-06-01

licence_typestringrequired

F = Full UK Car Licence, FA = Full UK (automatic only), P = Provisional UK, E = Full EU, H = Full European non-EU, N = Full International

Example F

Allowed values
`F`	Full UK Car Licence
`FA`	Full UK (automatic only)
`P`	Provisional UK
`E`	Full EU
`H`	Full European non-EU
`N`	Full International

licence_numberstringoptional

Driving licence number (optional)

Example

licence_yearsintegerrequired

Years the licence has been held. 0 = less than 1 year; 25 = 25+.

0 to 25

Example 15

licence_datestring (date)optional

Date licence was obtained (YYYY-MM-DD). Required when licence_years = 0.

Example 2023-09-15

driving_qualificationstringrequired

DQN = None, DQA = AA Proficiency, DQI = IAM, DQP = Pass Plus

Example DQN

Allowed values
`DQN`	None
`DQA`	AA Proficiency
`DQI`	IAM
`DQP`	Pass Plus

driving_qualification_datestring (date)optional

Date the driving qualification was obtained (YYYY-MM-DD). Required when driving_qualification is not DQN.

Example 2018-04-01

use_other_vehiclesstringrequired

XVE = No access to other cars, 1VE = Own another car/van, UVE = Have use of another car, COVE = Company car (incl. personal), CXVE = Company car (excl. personal)

Example XVE

Allowed values
`XVE`	No access to other cars
`1VE`	Own another car/van
`UVE`	Have use of another car
`COVE`	Company car (incl. personal)
`CXVE`	Company car (excl. personal)

non_motoring_convictionsbooleanrequired

Example false

dvla_medical_conditionstringrequired

DVN = No conditions, DVR = DVLA aware (no restrictions), DV1 = DVLA aware (1-year restricted), DV2 = DVLA aware (2-year restricted), DV3 = DVLA aware (3-year restricted), DVU = DVLA unaware

Example DVN

Allowed values
`DVN`	No conditions
`DVR`	DVLA aware (no restrictions)
`DV1`	DVLA aware (1-year restricted)
`DV2`	DVLA aware (2-year restricted)
`DV3`	DVLA aware (3-year restricted)
`DVU`	DVLA unaware

vehicle_usagestringrequired

02YN = SDPC, 05NN = SDP, 15YY = SDPC + Business (proposer only), 11YY = SDPC + Business (proposer/spouse), 12YY = SDPC + Business (any named driver)

Example 02YN

Allowed values
`02YN`	SDPC
`05NN`	SDP
`15YY`	SDPC + Business (proposer only)
`11YY`	SDPC + Business (proposer/spouse)
`12YY`	SDPC + Business (any named driver)

insurance_cancelledbooleanrequired

Example false

claimsarray of objectoptional

[item]objectoptional

claim_typestringrequired

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

convictionsarray of objectoptional

[item]objectoptional

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

your_coverobjectrequired

registration_numberstringrequired

Vehicle registration number

Example BV63GHJ

abi_codestringrequired

ABI code for the vehicle. Make and model are derived from this code by the platform and do not need to be submitted separately.

Example 35690305

engine_sizestringrequired

Engine displacement in cc

Example 1598

year_of_manufacturerstringrequired

Year of manufacture (YYYY)

pattern ^\d{4}$

Example 2013

transmissionstringrequired

Manual = Manual gearbox, Auto = Automatic gearbox

Example Manual

Allowed values
`Manual`	Manual gearbox
`Auto`	Automatic gearbox

left_hand_drivebooleanrequired

true = Left hand drive, false = Right hand drive

Example false

no_seatsstringrequired

Number of seats in the vehicle

Example 5

doorsstringrequired

Number of doors on the vehicle

Example 4

alarm_immobiliserstringrequired

Example 99991

Allowed values
`#N`	None
`#F`	Factory Fitted (unspecified)
`99991`	Factory Fitted Thatcham Approved Alarm/Immobiliser
`99992`	Factory Fitted Thatcham Approved Alarm only
`99993`	Factory Fitted Non-Thatcham Alarm/Immobiliser
`99994`	Factory Fitted Non-Thatcham Alarm only

tracking_devicebooleanrequired

Is a tracking device fitted to the vehicle?

Example false

vehicle_valuenumberrequired

Current market value of the vehicle in GBP. Derived from CDL lookup where available; otherwise entered by the customer.

Example 22500

modifiedbooleanrequired

Has the vehicle been modified or adapted from standard? If true, the modifications array must be populated.

Example false

modificationsarray of objectoptional

List of modifications made to the vehicle. Required when modified is true. Codes are from the standard Modifications reference list.

[item]objectoptional

modification_typestringrequired

Modification type code from ABI List 86. Pass the standard ABI numeric code as a string.

Example 1

vehicle_importedbooleanrequired

Is the vehicle an import?

Example false

registered_ownerstringrequired

Example P

Allowed values
`P`	Proposer (policyholder)
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Company/Business Partner
`U`	Other
`R`	Brother/Sister or Leased Private
`J`	Civil Partner
`L`	Leased Company

registered_keeperstringrequired

Example P

Allowed values
`P`	Proposer (policyholder)
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Company/Business Partner
`U`	Other/Society or Club
`R`	Brother/Sister or Leased Private
`J`	Civil Partner
`L`	Leased Company

main_driverstringrequired

Reference ID of the main driver of the vehicle. Use "1" for the proposer, or the index of an additional driver (e.g. "2" for the first additional driver).

Example 1

purchase_datestring (date)optional

Date the vehicle was purchased (YYYY-MM-DD)

Example 2022-11-21

purchase_pricenumberrequired

Purchase price of the vehicle in GBP

Example 20000

vehicle_not_yet_purchasedbooleanrequired

Set to true if the vehicle has not yet been purchased. When true, purchase_date should be omitted.

Example false

vehicle_kept_at_main_addressbooleanrequired

Is the vehicle kept at the proposer's main address? If false, vehicle_kept_postcode and vehicle_kept_house_number must be provided.

Example true

vehicle_kept_postcodestringoptional

Postcode where the vehicle is kept, if different from the proposer's main address. Required when vehicle_kept_at_main_address is false.

Example M1 1AA

vehicle_kept_house_numberstringoptional

House number or name where the vehicle is kept, if different from the proposer's main address. Required when vehicle_kept_at_main_address is false.

Example 42

vehicle_daytime_locationstringoptional

Where the vehicle is kept during the day: VKD1 = At home address, VKD2 = Office or factory car park, VKD3 = Open public car park, VKD4 = Secure public car park, VKD5 = Street away from home

Example VKD1

Allowed values
`VKD1`	At home address
`VKD2`	Office or factory car park
`VKD3`	Open public car park
`VKD4`	Secure public car park
`VKD5`	Street away from home

overnight_parkingstringrequired

Example 10

Allowed values
`2`	Private property
`4`	Drive
`7`	Locked compound
`10`	Locked garage
`11`	Unlocked garage
`12`	Street outside home
`13`	Street away from home
`14`	Public car park
`15`	Work car park

inception_datestring (date)required

Desired cover start date (YYYY-MM-DD)

Example 2026-11-22

cover_typestringrequired

Level of cover: 01 = Comprehensive, 02 = Third Party, Fire and Theft, 03 = Third Party Only

Example 01

Allowed values
`01`	Comprehensive
`02`	Third Party, Fire and Theft
`03`	Third Party Only

vol_xsintegerrequired

Voluntary excess amount in GBP

Example 250

Allowed values
`0`
`50`
`100`
`150`
`200`
`250`
`300`
`350`
`400`
`450`
`500`
`600`
`700`
`800`
`900`
`1000`

ncbintegerrequired

No Claims Discount years (0–20, where 20 represents 20 or more)

0 to 20

Example 5

ncd_sourcestringoptional

Source of No Claims Discount (asked when ncb > 0): 1 = This vehicle or a previous vehicle, 3 = Company vehicle, 4 = Foreign insurer

Example 1

Allowed values
`1`	This vehicle or a previous vehicle
`3`	Company vehicle
`4`	Foreign insurer

protected_ncdbooleanrequired

Is the No Claims Discount protected?

Example false

named_driver_experiencestringoptional

Example NDN

Allowed values
`NDN`	None
`NDA`	Named driver on another car
`NDI`	Named driver on a company car (including personal use)
`NDE`	Named driver on a company car (excluding personal use)

named_driver_experience_yearsstringoptional

Years of claim-free named driver experience (asked when named_driver_experience is not NDN): NDY0 = 0 years, NDY1 = 1 year, ... NDY15 = 15 years or more

Example NDY3

Allowed values
`NDY0`	0 years
`NDY1`	1 year
`NDY2`
`NDY3`
`NDY4`
`NDY5`
`NDY6`
`NDY7`
`NDY8`
`NDY9`
`NDY10`
`NDY11`
`NDY12`
`NDY13`
`NDY14`
`NDY15`	15 years or more

`QuoteMetadata`

affiliate_idintegerrequired

Affiliate ID assigned by your account manager

Example 1

sourcestringoptional

Source identifier for tracking the origin of the quote

Example ogi-refer

s1stringoptional

Additional tracking variable (e.g. policy reference)

Example ANCX11PC01

`YourDetails`

titlestringrequired

Proposer's title

Example MR

Allowed values
`MR`
`MRS`
`MS`
`MISS`

first_namestringrequired

Proposer's first name

Example Chris

surnamestringrequired

Proposer's surname

Example Anthony

dobstring (date)required

Date of birth (YYYY-MM-DD)

Example 1990-04-03

marital_statusstringrequired

Marital status: M = Married, S = Single, P = Common Law Partnered/Cohabiting, D = Divorced/Dissolved, A = Separated, W = Widowed/Surviving Civil Partner, B = Civil Partnered

Example M

Allowed values
`M`	Married
`S`	Single
`P`	Common Law Partnered/Cohabiting
`D`	Divorced/Dissolved
`A`	Separated
`W`	Widowed/Surviving Civil Partner
`B`	Civil Partnered

emp_statusstringrequired

Employment status: E = Employed, H = Houseperson, F = Full/Part-time education, S = Self-employed, R = Retired, U = Unemployed, N = Not employed due to disability/illness

Example E

Allowed values
`E`	Employed
`H`	Houseperson
`F`	Full/Part-time education
`S`	Self-employed
`R`	Retired
`U`	Unemployed
`N`	Not employed due to disability/illness

occupationstringrequired

Occupation code from ABI List 55. Pass the standard ABI numeric code as a string.

Example 621

industrystringrequired

Industry/business code from ABI List 11. Pass the standard ABI numeric code as a string.

Example 561

postcodestringrequired

Proposer's home postcode

Example PR2 6UJ

address_1stringrequired

Address line 1

Example 7 Ingleton Road

address_2stringoptional

Address line 2

Example Ribbleton

citystringrequired

City

Example Preston

countystringrequired

County

Example Lancashire

vehicle_addressbooleanrequired

Is the vehicle kept at the proposer's home address?

Example true

email_addressstring (email)required

Contact email address

Example chris@example.com

contact_numberstringrequired

Contact telephone number. If not provided, defaults to 01000 000000.

Example 01234567890

how_paystringrequired

Preferred payment frequency: M = Monthly, F = In-full (annually)

Example F

Allowed values
`M`	Monthly
`F`	In-full (annually)

home_ownerbooleanrequired

Does the proposer own their home?

Example false

children_under_16booleanrequired

Does the proposer have any children under 16?

Example false

household_vehiclesintegerrequired

Total number of vehicles in the household, including this one

1 to 9

Example 1

uk_resident_since_dobbooleanrequired

Has the proposer been a permanent UK resident since birth? If false, uk_resident_since must be provided.

Example true

uk_resident_sincestring (date)optional

Date the proposer became a permanent UK resident (YYYY-MM-DD). Required when uk_resident_since_dob is false.

Example 2005-06-01

licence_typestringrequired

Example F

Allowed values
`F`	Full UK Car Licence
`FA`	Full UK Car Licence (automatic only)
`P`	Provisional UK Car Licence
`E`	Full EU Licence
`H`	Full European non-EU Licence
`N`	Full International Licence

licence_numberstringoptional

Driving licence number (optional)

Example ANTHO904031CA9TB

licence_yearsintegerrequired

Number of years the licence has been held. 0 = less than 1 year (licence_date must then be provided). 25 = 25 years or more.

0 to 25

Example 14

licence_datestring (date)optional

Date the licence was obtained (YYYY-MM-DD). Required when licence_years = 0 (less than 1 year).

Example 2023-09-15

driving_qualificationstringrequired

Advanced driving qualification held (if any): DQN = None, DQA = AA Proficiency, DQI = Institute of Advanced Motorists (IAM), DQP = Pass Plus

Example DQN

Allowed values
`DQN`	None
`DQA`	AA Proficiency
`DQI`	Institute of Advanced Motorists (IAM)
`DQP`	Pass Plus

driving_qualification_datestring (date)optional

Date the driving qualification was obtained (YYYY-MM-DD). Required when driving_qualification is not DQN.

Example 2018-04-01

use_other_vehiclesstringrequired

Example XVE

Allowed values
`XVE`	No access to any other cars
`1VE`	Own another car or van
`UVE`	Have use of another car
`COVE`	Company car (including personal use)
`CXVE`	Company car (excluding personal use)

non_motoring_convictionsbooleanrequired

Does the proposer have any non-motoring criminal convictions?

Example false

dvla_medical_conditionstringrequired

Example DVN

Allowed values
`DVN`	No medical conditions
`DVR`	DVLA aware – No restrictions
`DV1`	DVLA aware – 1 year restricted licence
`DV2`	DVLA aware – 2 year restricted licence
`DV3`	DVLA aware – 3 year restricted licence
`DVU`	DVLA unaware

vehicle_usagestringrequired

Example 02YN

Allowed values
`02YN`	Social, Domestic, Pleasure and Commuting (SDPC)
`05NN`	Social, Domestic and Pleasure only (SDP)
`15YY`	SDPC and Business use (proposer only)
`11YY`	SDPC and Business use (proposer/spouse only)
`12YY`	SDPC and Business use (any named driver)

mileageintegerrequired

Estimated annual private mileage

Example 9000

business_mileageintegeroptional

Estimated annual business mileage. Required when vehicle_usage is 15YY, 11YY or 12YY.

Example 5000

insurance_cancelledbooleanrequired

Has the proposer (or any named driver) ever had an insurance policy declined, cancelled, voided, or had special terms imposed?

Example false

claimsarray of objectoptional

Motor accidents or claims in the last 5 years

[item]objectoptional

claim_typestringrequired

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

convictionsarray of objectoptional

Motoring convictions, fixed penalties or disqualifications (including pending)

[item]objectoptional

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

`AdditionalDriver`

relationshipstringrequired

Example W

Allowed values
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Business Partner
`U`	Other
`R`	Brother/Sister
`J`	Civil Partner

titlestringrequired

Example MISS

Allowed values
`MR`
`MRS`
`MS`
`MISS`

first_namestringrequired

Example Jayne

surnamestringrequired

Example Smith

dobstring (date)required

Date of birth (YYYY-MM-DD)

Example 1991-02-01

marital_statusstringrequired

M = Married, S = Single, P = Common Law Partnered/Cohabiting, D = Divorced/Dissolved, A = Separated, W = Widowed/Surviving Civil Partner, B = Civil Partnered

Example S

Allowed values
`M`	Married
`S`	Single
`P`	Common Law Partnered/Cohabiting
`D`	Divorced/Dissolved
`A`	Separated
`W`	Widowed/Surviving Civil Partner
`B`	Civil Partnered

emp_statusstringrequired

E = Employed, H = Houseperson, F = Full/Part-time education, S = Self-employed, R = Retired, U = Unemployed, N = Not employed due to disability/illness

Example E

Allowed values
`E`	Employed
`H`	Houseperson
`F`	Full/Part-time education
`S`	Self-employed
`R`	Retired
`U`	Unemployed
`N`	Not employed due to disability/illness

occupationstringrequired

Occupation code from ABI List 55

Example 114

industrystringrequired

Industry/business code from ABI List 11

Example 620

uk_resident_since_dobbooleanrequired

Has the driver been a permanent UK resident since birth? If false, uk_resident_since must be provided.

Example true

uk_resident_sincestring (date)optional

Date the driver became a permanent UK resident (YYYY-MM-DD). Required when uk_resident_since_dob is false.

Example 2005-06-01

licence_typestringrequired

F = Full UK Car Licence, FA = Full UK (automatic only), P = Provisional UK, E = Full EU, H = Full European non-EU, N = Full International

Example F

Allowed values
`F`	Full UK Car Licence
`FA`	Full UK (automatic only)
`P`	Provisional UK
`E`	Full EU
`H`	Full European non-EU
`N`	Full International

licence_numberstringoptional

Driving licence number (optional)

Example

licence_yearsintegerrequired

Years the licence has been held. 0 = less than 1 year; 25 = 25+.

0 to 25

Example 15

licence_datestring (date)optional

Date licence was obtained (YYYY-MM-DD). Required when licence_years = 0.

Example 2023-09-15

driving_qualificationstringrequired

DQN = None, DQA = AA Proficiency, DQI = IAM, DQP = Pass Plus

Example DQN

Allowed values
`DQN`	None
`DQA`	AA Proficiency
`DQI`	IAM
`DQP`	Pass Plus

driving_qualification_datestring (date)optional

Date the driving qualification was obtained (YYYY-MM-DD). Required when driving_qualification is not DQN.

Example 2018-04-01

use_other_vehiclesstringrequired

XVE = No access to other cars, 1VE = Own another car/van, UVE = Have use of another car, COVE = Company car (incl. personal), CXVE = Company car (excl. personal)

Example XVE

Allowed values
`XVE`	No access to other cars
`1VE`	Own another car/van
`UVE`	Have use of another car
`COVE`	Company car (incl. personal)
`CXVE`	Company car (excl. personal)

non_motoring_convictionsbooleanrequired

Example false

dvla_medical_conditionstringrequired

DVN = No conditions, DVR = DVLA aware (no restrictions), DV1 = DVLA aware (1-year restricted), DV2 = DVLA aware (2-year restricted), DV3 = DVLA aware (3-year restricted), DVU = DVLA unaware

Example DVN

Allowed values
`DVN`	No conditions
`DVR`	DVLA aware (no restrictions)
`DV1`	DVLA aware (1-year restricted)
`DV2`	DVLA aware (2-year restricted)
`DV3`	DVLA aware (3-year restricted)
`DVU`	DVLA unaware

vehicle_usagestringrequired

02YN = SDPC, 05NN = SDP, 15YY = SDPC + Business (proposer only), 11YY = SDPC + Business (proposer/spouse), 12YY = SDPC + Business (any named driver)

Example 02YN

Allowed values
`02YN`	SDPC
`05NN`	SDP
`15YY`	SDPC + Business (proposer only)
`11YY`	SDPC + Business (proposer/spouse)
`12YY`	SDPC + Business (any named driver)

insurance_cancelledbooleanrequired

Example false

claimsarray of objectoptional

[item]objectoptional

claim_typestringrequired

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

convictionsarray of objectoptional

[item]objectoptional

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

`Claim`

claim_typestringrequired

Example A

Allowed values
`A`	Accident
`T`	Theft of Vehicle
`M`	Theft Related Damage
`V`	Malicious Damage
`W`	Windscreen Only
`F`	Fire Damage
`1`	Theft – Sound Equipment
`2`	Theft – Personal Effects
`3`	Theft – Accessories
`S`	Storm Damage
`4`	Riot Damage
`5`	Lightning Damage
`6`	Explosion

claim_datestring (date)required

Date the incident occurred (YYYY-MM-DD)

Example 2019-05-02

claim_damagestringrequired

Damage status: 0 = Cost known, 1 = No damage, 2 = Write-off, 3 = Unknown

Example 0

Allowed values
`0`	Cost known
`1`	No damage
`2`	Write-off
`3`	Unknown

claim_valuenumberrequired

Total cost of the claim in GBP

Example 1000

claim_made_against_insurancebooleanrequired

Was this claim made against an insurance policy?

Example true

driverstringoptional

Driver ID involved in the claim (person reference). Required for accident claims (claim_type = A) when additional drivers are present.

Example 1

at_faultstringoptional

Who was at fault (required for accident claims, claim_type = A): C = Our Driver, N = No other vehicle involved, O = Other Party, B = Both Parties, S = Unoccupied Vehicle

Example O

Allowed values
`C`	Our Driver
`N`	No other vehicle involved
`O`	Other Party
`B`	Both Parties
`S`	Unoccupied Vehicle

ncd_affectedbooleanrequired

Was No Claims Discount affected by this claim? Asked for all claim types except Windscreen Only (W).

Example false

injuriesbooleanoptional

Were there any injuries? Applicable to accident claims (claim_type = A).

Example false

`Conviction`

conviction_datestring (date)required

Date of conviction (YYYY-MM-DD)

Example 2019-12-09

conviction_codestringrequired

Standard ABI List 24 conviction code (e.g. SP10, DR20, IN10). See ABI motor conviction code list for full reference.

Example DR20

pointsintegerrequired

Number of penalty points imposed

0 to any

Example 20

banintegerrequired

Length of driving ban in months (0 if no ban)

0 to any

Example 9

amountnumberrequired

Fine amount in GBP (0 if no fine)

Example 100

breathalysedbooleanoptional

Was the driver breathalysed? Required when conviction_code is a drink-related offence (DR prefix).

Example true

breathalyser_readingintegeroptional

Breathalyser reading in micrograms per 100 millilitres of breath. Required when breathalysed is true.

Example 87

`Modification`

modification_typestringrequired

Modification type code from ABI List 86. Pass the standard ABI numeric code as a string.

Example 1

`YourCover`

registration_numberstringrequired

Vehicle registration number

Example BV63GHJ

abi_codestringrequired

ABI code for the vehicle. Make and model are derived from this code by the platform and do not need to be submitted separately.

Example 35690305

engine_sizestringrequired

Engine displacement in cc

Example 1598

year_of_manufacturerstringrequired

Year of manufacture (YYYY)

pattern ^\d{4}$

Example 2013

transmissionstringrequired

Manual = Manual gearbox, Auto = Automatic gearbox

Example Manual

Allowed values
`Manual`	Manual gearbox
`Auto`	Automatic gearbox

left_hand_drivebooleanrequired

true = Left hand drive, false = Right hand drive

Example false

no_seatsstringrequired

Number of seats in the vehicle

Example 5

doorsstringrequired

Number of doors on the vehicle

Example 4

alarm_immobiliserstringrequired

Example 99991

Allowed values
`#N`	None
`#F`	Factory Fitted (unspecified)
`99991`	Factory Fitted Thatcham Approved Alarm/Immobiliser
`99992`	Factory Fitted Thatcham Approved Alarm only
`99993`	Factory Fitted Non-Thatcham Alarm/Immobiliser
`99994`	Factory Fitted Non-Thatcham Alarm only

tracking_devicebooleanrequired

Is a tracking device fitted to the vehicle?

Example false

vehicle_valuenumberrequired

Current market value of the vehicle in GBP. Derived from CDL lookup where available; otherwise entered by the customer.

Example 22500

modifiedbooleanrequired

Has the vehicle been modified or adapted from standard? If true, the modifications array must be populated.

Example false

modificationsarray of objectoptional

List of modifications made to the vehicle. Required when modified is true. Codes are from the standard Modifications reference list.

[item]objectoptional

modification_typestringrequired

Modification type code from ABI List 86. Pass the standard ABI numeric code as a string.

Example 1

vehicle_importedbooleanrequired

Is the vehicle an import?

Example false

registered_ownerstringrequired

Example P

Allowed values
`P`	Proposer (policyholder)
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Company/Business Partner
`U`	Other
`R`	Brother/Sister or Leased Private
`J`	Civil Partner
`L`	Leased Company

registered_keeperstringrequired

Example P

Allowed values
`P`	Proposer (policyholder)
`S`	Spouse
`W`	Common Law Partner/Cohabitee
`O`	Son/Daughter
`M`	Parent
`F`	Other Family
`E`	Employee
`B`	Employer
`C`	Company/Business Partner
`U`	Other/Society or Club
`R`	Brother/Sister or Leased Private
`J`	Civil Partner
`L`	Leased Company

main_driverstringrequired

Reference ID of the main driver of the vehicle. Use "1" for the proposer, or the index of an additional driver (e.g. "2" for the first additional driver).

Example 1

purchase_datestring (date)optional

Date the vehicle was purchased (YYYY-MM-DD)

Example 2022-11-21

purchase_pricenumberrequired

Purchase price of the vehicle in GBP

Example 20000

vehicle_not_yet_purchasedbooleanrequired

Set to true if the vehicle has not yet been purchased. When true, purchase_date should be omitted.

Example false

vehicle_kept_at_main_addressbooleanrequired

Is the vehicle kept at the proposer's main address? If false, vehicle_kept_postcode and vehicle_kept_house_number must be provided.

Example true

vehicle_kept_postcodestringoptional

Postcode where the vehicle is kept, if different from the proposer's main address. Required when vehicle_kept_at_main_address is false.

Example M1 1AA

vehicle_kept_house_numberstringoptional

House number or name where the vehicle is kept, if different from the proposer's main address. Required when vehicle_kept_at_main_address is false.

Example 42

vehicle_daytime_locationstringoptional

Where the vehicle is kept during the day: VKD1 = At home address, VKD2 = Office or factory car park, VKD3 = Open public car park, VKD4 = Secure public car park, VKD5 = Street away from home

Example VKD1

Allowed values
`VKD1`	At home address
`VKD2`	Office or factory car park
`VKD3`	Open public car park
`VKD4`	Secure public car park
`VKD5`	Street away from home

overnight_parkingstringrequired

Example 10

Allowed values
`2`	Private property
`4`	Drive
`7`	Locked compound
`10`	Locked garage
`11`	Unlocked garage
`12`	Street outside home
`13`	Street away from home
`14`	Public car park
`15`	Work car park

inception_datestring (date)required

Desired cover start date (YYYY-MM-DD)

Example 2026-11-22

cover_typestringrequired

Level of cover: 01 = Comprehensive, 02 = Third Party, Fire and Theft, 03 = Third Party Only

Example 01

Allowed values
`01`	Comprehensive
`02`	Third Party, Fire and Theft
`03`	Third Party Only

vol_xsintegerrequired

Voluntary excess amount in GBP

Example 250

Allowed values
`0`
`50`
`100`
`150`
`200`
`250`
`300`
`350`
`400`
`450`
`500`
`600`
`700`
`800`
`900`
`1000`

ncbintegerrequired

No Claims Discount years (0–20, where 20 represents 20 or more)

0 to 20

Example 5

ncd_sourcestringoptional

Source of No Claims Discount (asked when ncb > 0): 1 = This vehicle or a previous vehicle, 3 = Company vehicle, 4 = Foreign insurer

Example 1

Allowed values
`1`	This vehicle or a previous vehicle
`3`	Company vehicle
`4`	Foreign insurer

protected_ncdbooleanrequired

Is the No Claims Discount protected?

Example false

named_driver_experiencestringoptional

Example NDN

Allowed values
`NDN`	None
`NDA`	Named driver on another car
`NDI`	Named driver on a company car (including personal use)
`NDE`	Named driver on a company car (excluding personal use)

named_driver_experience_yearsstringoptional

Years of claim-free named driver experience (asked when named_driver_experience is not NDN): NDY0 = 0 years, NDY1 = 1 year, ... NDY15 = 15 years or more

Example NDY3

Allowed values
`NDY0`	0 years
`NDY1`	1 year
`NDY2`
`NDY3`
`NDY4`
`NDY5`
`NDY6`
`NDY7`
`NDY8`
`NDY9`
`NDY10`
`NDY11`
`NDY12`
`NDY13`
`NDY14`
`NDY15`	15 years or more

`QuoteResponse`

Array of quote results from the Re:New panel aggregator. Each item represents a quote from a panel provider.

[item]objectoptional

quote_idstringoptional

Unique identifier for this individual quote

Example 42

statusstringoptional

Status of the quote (e.g. Complete, Failed, Referred)

Example Complete

pricestringoptional

Quoted premium in GBP

Example 251.28

brand_namestringoptional

Brand name of the quoting provider

Example GotYouCovered

product_namestringoptional

Product name for the quote

Example GotYouCovered

referencestringoptional

Provider's unique reference for this quote

Example UGYCAPI-C3D003D10W

deeplinkstring (uri)optional

Direct URL for the customer to view/purchase this quote

Example http://gotyoucovered-test.sostec.co.uk/car-insurance/webservice/deeplink/?quote_id=42&email=&results_id=20

`QuoteResult`

quote_idstringoptional

Unique identifier for this individual quote

Example 42

statusstringoptional

Status of the quote (e.g. Complete, Failed, Referred)

Example Complete

pricestringoptional

Quoted premium in GBP

Example 251.28

brand_namestringoptional

Brand name of the quoting provider

Example GotYouCovered

product_namestringoptional

Product name for the quote

Example GotYouCovered

referencestringoptional

Provider's unique reference for this quote

Example UGYCAPI-C3D003D10W

deeplinkstring (uri)optional

Direct URL for the customer to view/purchase this quote

Example http://gotyoucovered-test.sostec.co.uk/car-insurance/webservice/deeplink/?quote_id=42&email=&results_id=20

`ErrorResponse`

successbooleanoptional

Example false

error_codestringoptional

Example VALIDATION_ERROR

messagestringoptional

Example Required field 'dob' is missing

fieldsarray of stringoptional

List of fields that failed validation

Changelog

v2.0.0
- Current contract: full risk data for the proposer, up to 5 additional drivers, the vehicle and cover. Returns the panel's quotes to the caller.

POST /car-insurance/webservice/quote/json/

curl -X POST "https://renewbroking-test.sostec.co.uk/car-insurance/webservice/quote/json/" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "quote": {
    "affiliate_id": 1,
    "source": "ogi-refer",
    "s1": "ANCX11PC01"
  },
  "your_details": {
    "title": "MR",
    "first_name": "Chris",
    "surname": "Anthony",
    "dob": "1990-04-03",
    "marital_status": "M",
    "emp_status": "E",
    "occupation": "621",
    "industry": "561",
    "postcode": "PR2 6UJ",
    "address_1": "7 Ingleton Road",
    "address_2": "Ribbleton",
    "city": "Preston",
    "county": "Lancashire",
    "vehicle_address": true,
    "email_address": "chris.anthony@example.com",
    "contact_number": "01234567890",
    "how_pay": "F",
    "home_owner": false,
    "children_under_16": false,
    "household_vehicles": 1,
    "uk_resident_since_dob": true,
    "licence_type": "F",
    "licence_years": 14,
    "driving_qualification": "DQN",
    "use_other_vehicles": "XVE",
    "non_motoring_convictions": false,
    "dvla_medical_condition": "DVN",
    "vehicle_usage": "02YN",
    "mileage": 9000,
    "insurance_cancelled": false,
    "claims": [
      {
        "claim_type": "A",
        "claim_date": "2019-05-02",
        "claim_damage": "0",
        "claim_value": 1000,
        "claim_made_against_insurance": true,
        "at_fault": "O",
        "ncd_affected": false,
        "injuries": false
      }
    ],
    "convictions": [
      {
        "conviction_date": "2019-12-09",
        "conviction_code": "DR20",
        "points": 20,
        "ban": 9,
        "amount": 100,
        "breathalysed": true,
        "breathalyser_reading": 87
      }
    ]
  },
  "additional_drivers": [
    {
      "relationship": "W",
      "title": "MISS",
      "first_name": "Jayne",
      "surname": "Smith",
      "dob": "1991-02-01",
      "marital_status": "S",
      "emp_status": "E",
      "occupation": "114",
      "industry": "620",
      "uk_resident_since_dob": true,
      "licence_type": "F",
      "licence_years": 15,
      "driving_qualification": "DQN",
      "use_other_vehicles": "XVE",
      "non_motoring_convictions": false,
      "dvla_medical_condition": "DVR",
      "vehicle_usage": "02YN",
      "insurance_cancelled": false
    }
  ],
  "your_cover": {
    "registration_number": "BV63GHJ",
    "abi_code": "35690305",
    "engine_size": "1598",
    "year_of_manufacturer": "2013",
    "transmission": "Manual",
    "left_hand_drive": false,
    "no_seats": "5",
    "doors": "4",
    "alarm_immobiliser": "99991",
    "tracking_device": false,
    "vehicle_value": 22500,
    "modified": false,
    "vehicle_imported": false,
    "registered_owner": "P",
    "registered_keeper": "P",
    "main_driver": "1",
    "purchase_date": "2022-11-21",
    "purchase_price": 20000,
    "vehicle_not_yet_purchased": false,
    "vehicle_kept_at_main_address": true,
    "vehicle_daytime_location": "VKD1",
    "overnight_parking": "10",
    "inception_date": "2026-11-22",
    "cover_type": "01",
    "vol_xs": 250,
    "ncb": 5,
    "ncd_source": "1",
    "protected_ncd": false
  }
}'

200 response

[
  {
    "quote_id": "42",
    "status": "Complete",
    "price": "251.28",
    "brand_name": "GotYouCovered",
    "product_name": "GotYouCovered",
    "reference": "UGYCAPI-C3D003D10W",
    "deeplink": "http://gotyoucovered-test.sostec.co.uk/car-insurance/webservice/deeplink/?quote_id=42&email=&results_id=20"
  }
]