Create Quote

POST /api/v1/Quotes/Create

Overview

Using the create quote API will pass the details of the request into our quotation engine and return a list of quotations

The request and response will be save so they are easily accessible at a later date.

Request/response samples

Please be sure to use the correct [API Domain] in your request.

Click the download icons to download example json files for development.

Request sample

JSON Example

POST https://[API Domain]/api/v1/Quotes/Create

{
  "sessionId": "ac2a941e-04ac-43a0-8308-7aaac35659b8",
  "quoteType": 3,
  "purchase": {
    "plannedUse": null,
    "foundProperty": null,
    "propertyType": null,
    "haveMortgageLender": null,
    "firstTimeBuyer": false,
    "newBuild": false,
    "helpToBuyIsa": false,
    "numberOfHelpToBuyIsas": 0,
    "giftedDeposit": false,
    "numberOfGiftedDeposits": 0,
    "giftedEquity": false,
    "soleBorrowerJointProprietor": false,
    "jointBorrowerSoleProprietor": false,
    "armedForcesHelpToBuy": false,
    "rightToBuy": false,
    "address": {
      "subBuildingNumber": null,
      "subBuildingName": null,
      "buildingNumber": "45",
      "buildingName": null,
      "thoroughfare": null,
      "line1": "45 Kings Avenue",
      "line2": null,
      "line3": null,
      "line4": null,
      "locality": null,
      "townOrCity": "Peckham",
      "county": "London",
      "district": null,
      "postcode": "SE15 1TB",
      "country": "England",
      "latitude": null,
      "longitude": null
    },
    "tenure": null,
    "numberOfOwners": 0,
    "foreignOwners": null,
    "numberOfForeignOwners": 0,
    "price": 0,
    "limitedCompany": null,
    "usingMortgage": null,
    "mortgageLenderId": null,
    "houseOfMultipleOccupancy": false,
    "studentProperty": null,
    "helpToBuyEquityLoan": false,
    "sharedOwnership": false
  },
  "sale": {
    "nextLender": null,
    "saleAtUndervalue": false,
    "address": {
      "subBuildingNumber": null,
      "subBuildingName": null,
      "buildingNumber": null,
      "buildingName": "Nelson Mandela House",
      "thoroughfare": null,
      "line1": "Flat 1210",
      "line2": "Floor 12",
      "line3": "Nyrere Estate",
      "line4": null,
      "locality": null,
      "townOrCity": "Peckham",
      "county": "London",
      "district": null,
      "postcode": "SE15 9DR",
      "country": "England",
      "latitude": null,
      "longitude": null
    },
    "tenure": 2,
    "numberOfOwners": 1,
    "foreignOwners": false,
    "numberOfForeignOwners": 0,
    "price": 450000,
    "limitedCompany": null,
    "usingMortgage": null,
    "mortgageLenderId": null,
    "houseOfMultipleOccupancy": false,
    "studentProperty": null,
    "helpToBuyEquityLoan": false,
    "sharedOwnership": false
  }
}

Request/response Schema

Schema request overview

ConveyancerQuoteRequest - the root object for the request

Field Name	Field Type	Mandatory	Notes
SessionId	Guid	True	This session id will be used as a primary key for all quopte information used in this session. The session is obtained by using the `/api/UserSession/Create` endpoint.
QuoteType	Nullable(QuoteType)	True	This is the quote type you are requesting, you must supply a valid Quote Type : Sale = 1, Purchase = 2, SalePurchase = 3
Purchase	ConveyancerPurchaseQuoteRequest	True
Sale	ConveyancerSaleQuoteRequest	True

ConveyancerPurchaseQuoteRequest - the object for supplying purchase quote request

Field Name	Field Type	Mandatory
PlannedUse	Nullable(PlannedUse)	False
FoundProperty	Nullable(Boolean)	False
PropertyType	Nullable(PropertyType)	False
HaveMortgageLender	Nullable(Boolean)	False
FirstTimeBuyer	Boolean	True
NewBuild	Boolean	True
HelpToBuyIsa	Boolean	True
NumberOfHelpToBuyIsas	Int32	True
GiftedDeposit	Boolean	True
NumberOfGiftedDeposits	Int32	True
GiftedEquity	Boolean	True
SoleBorrowerJointProprietor	Boolean	True
JointBorrowerSoleProprietor	Boolean	True
ArmedForcesHelpToBuy	Boolean	True
RightToBuy	Boolean	True
Address	Address	True
Tenure	Nullable(TenureType)	False
NumberOfOwners	Int32	True
ForeignOwners	Nullable(Boolean)	False
NumberOfForeignOwners	Int32	True
Price	Decimal	True
LimitedCompany	Nullable(Boolean)	False
UsingMortgage	Nullable(Boolean)	False
MortgageLenderId	Nullable(Int32)	False
HouseOfMultipleOccupancy	Boolean	True
StudentProperty	Nullable(Boolean)	False
HelpToBuyEquityLoan	Boolean	True
SharedOwnership	Boolean	True