/quotes

Quote API is for creating priced quotes from Swallow pricing projects, and returning quote data at volume.

Create a quote

This is a public API endpoint. You can hit this endpoint for client-side code by just providing client_id_key in the header. View authentication to find out more. Public APIs have /public/ within the endpoint url.

Create a price from a quote (public)

POSThttps://api.llow.io/sw/public/quotes/{project_reference}

Path parameters

project_reference*string

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

Query parameters

Body

post to /sw/public/quotes/{project_reference}

ageinteger

Example age input

Example: 23

namestring

Example name input

Example: "Smith"

postcodestring

Example postcode input

Example: "SW1A1AA"

emailstring

Example email input

Example: "bob@smith.com"

Response

/sw/public/quotes/{project_reference} response

Body

quote_referencestring

Quote reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

company_referencestring

Company reference. It is a UUID.

Example: "86c575d2-b6b9-44ed-9c75-8d705b987ec1"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

resultnumber

The priced result of the quote

Example: 400

validboolean

The validity of the quote

Example: true

refersarray of object

A list of refers on a quote.

exclusionsarray of object

A list of exclusions on a quote

excessesarray of object

A list of applied excesses on a quote.

endorsementsarray of object

A list of endorsements names on a quote.

indicatorsstring

Example: "indicator_value_1::indicator_value_2::indicator_value_3"

execution_timeinteger

Time in milliseconds for the quote to return

Example: 125

outputobject

The outputs result of the quote including any defined additional outputs.

inputobject

The inputs provided in the initial quote.

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

Request

const response = await fetch('https://api.llow.io/sw/public/quotes/{project_reference}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "quote_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "version": 1,
  "result": 400,
  "valid": true,
  "refers": [],
  "exclusions": [],
  "excesses": [],
  "endorsements": [],
  "indicators": "indicator_value_1::indicator_value_2::indicator_value_3",
  "execution_time": 125,
  "output": {
    "result": 100,
    "valid": true,
    "tax": 15,
    "commission": 21
  },
  "input": {
    "age": 23,
    "name": "Rimmer",
    "email": "cal@cal.com",
    "postcode": "PO343TR"
  },
  "created_at": "2021-03-22T14:29:22.000Z"
}

This is a private API endpoint. You have to hit it with both client_id_key and client_secret_key in the header. You should only hit this POST endpoint server-side.

Create a price from a quote

POSThttps://api.llow.io/sw/quotes/{project_reference}

Path parameters

project_reference*string

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

Query parameters

Body

post to /sw/quotes/{project_reference}

ageinteger

Example age input

Example: 23

namestring

Example name input

Example: "Smith"

postcodestring

Example postcode input

Example: "SW1A1AA"

emailstring

Example email input

Example: "bob@smith.com"

Response

/sw/quotes/{project_reference} response

Body

quote_referencestring

Quote reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

company_referencestring

Company reference. It is a UUID.

Example: "86c575d2-b6b9-44ed-9c75-8d705b987ec1"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

resultnumber

The priced result of the quote

Example: 400

validboolean

The validity of the quote

Example: true

refersarray of object

A list of refers on a quote.

exclusionsarray of object

A list of exclusions on a quote

excessesarray of object

A list of applied excesses on a quote.

endorsementsarray of object

A list of endorsements names on a quote.

indicatorsstring

Example: "indicator_value_1::indicator_value_2::indicator_value_3"

execution_timeinteger

Time in milliseconds for the quote to return

Example: 125

outputobject

The outputs result of the quote including any defined additional outputs.

inputobject

The inputs provided in the initial quote.

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

Request

const response = await fetch('https://api.llow.io/sw/quotes/{project_reference}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "quote_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "version": 1,
  "result": 400,
  "valid": true,
  "refers": [],
  "exclusions": [],
  "excesses": [],
  "endorsements": [],
  "indicators": "indicator_value_1::indicator_value_2::indicator_value_3",
  "execution_time": 125,
  "output": {
    "result": 100,
    "valid": true,
    "tax": 15,
    "commission": 21
  },
  "input": {
    "age": 23,
    "name": "Rimmer",
    "email": "cal@cal.com",
    "postcode": "PO343TR"
  },
  "created_at": "2021-03-22T14:29:22.000Z"
}

The request body should match the inputs that are defined within your Swallow pricing project. You can see the desired payload by looking at the Try page of any project or project version. For example:

{
        "name": "Smith",
        "date_of_birth": "1990-01-01",
        "country": "UK",
        "duration_days": 5,
        "is_healthy": true
}

The response body will return the priced quote with the outputs that are defined within your Swallow pricing project.

{
	"company_reference": "098ae4f2-3af8-4740-8760-5d312e46742c",
	"project_reference": "1085e088-5501-4cc0-babd-464c6ae04707",
	"version_reference": "862360ff-fe53-40e1-8f11-57bf9a6f7477",
	"quote_reference": "e8733d88-b560-44d4-8c03-b2366dfd2cbb",
	"version": 1,
	"indicators": "bob@smith.com::Smith",
	"output": {
		"commission": 31.46,
		"tax": 23.595,
		"result": 212.36,
		"valid": true
	},
	"input": {
	        "name": "Smith",
	        "date_of_birth": "1990-01-01",
	        "country": "UK",
	        "duration_days": 5,
	        "is_healthy": true
	},
	"created_at": "2023-09-20T09:32:43.865Z",
}

To respond with debugging details, provide ?debug=true as a query parameter within the endpoint. This will return an additional parameter called debug with granular detail of how the quote was created. This will not work on the public quote endpoint.

{
    ...    
    "debug": {
        "timer": [],
        "errors": [],
        "exclusions": [],
        "refers": [],
        "excesses": [],
        "endorsements": [],
        "indicators": {},
        "steps": {}
    }
    ...
}

Retrieve quotes

Return all priced quotes

GEThttps://api.llow.io/sw/quotes

Query parameters

Response

/sw/quotes response

Body

quote_referencestring

Quote reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

company_referencestring

Company reference. It is a UUID.

Example: "86c575d2-b6b9-44ed-9c75-8d705b987ec1"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

resultnumber

The priced result of the quote

Example: 400

validboolean

The validity of the quote

Example: true

refersarray of object

A list of refers on a quote.

exclusionsarray of object

A list of exclusions on a quote

excessesarray of object

A list of applied excesses on a quote.

endorsementsarray of object

A list of endorsements names on a quote.

indicatorsstring

Example: "indicator_value_1::indicator_value_2::indicator_value_3"

execution_timeinteger

Time in milliseconds for the quote to return

Example: 125

outputobject

The outputs result of the quote including any defined additional outputs.

inputobject

The inputs provided in the initial quote.

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

Request

const response = await fetch('https://api.llow.io/sw/quotes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "quote_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "version": 1,
  "result": 400,
  "valid": true,
  "refers": [],
  "exclusions": [],
  "excesses": [],
  "endorsements": [],
  "indicators": "indicator_value_1::indicator_value_2::indicator_value_3",
  "execution_time": 125,
  "output": {
    "result": 100,
    "valid": true,
    "tax": 15,
    "commission": 21
  },
  "input": {
    "age": 23,
    "name": "Rimmer",
    "email": "cal@cal.com",
    "postcode": "PO343TR"
  },
  "created_at": "2021-03-22T14:29:22.000Z"
}

Quotes can be fetched in bulk or filtered (via a ?search query) on indicators that are defined in the inputs of Swallow pricing models. Indicators are up to 4 defined input parameters that can be searched (e.g. name, password, registration, zip code, postcode).

https://api.llow.io/sw/quotes?search=bob@smith.com

Quotes can also be filtered on a specific version_reference or project_reference.

https://api.llow.io/sw/quotes?version_reference=862360ff-fe53-40e1-8f11-57bf9a6f7477

Retrieve quote detail

Return a price quoted details

GEThttps://api.llow.io/sw/quotes/{quote_reference}

Path parameters

quote_reference*string

Quote reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

Query parameters

Response

/sw/quotes/{quote_reference} response

Body

quote_referencestring

Quote reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

metastring

inputobject

The inputs provided in the initial quote.

outputobject

The outputs result of the quote including any defined additional outputs.

debugobject

The detailed debug response for the quote.

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

Request

const response = await fetch('https://api.llow.io/sw/quotes/{quote_reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "quote_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "meta": {
    "name": "Monthly motor insurance product",
    "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
    "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
    "version": 1
  },
  "input": {
    "age": 23,
    "name": "Rimmer",
    "email": "cal@cal.com",
    "postcode": "PO343TR"
  },
  "output": {
    "result": 100,
    "valid": true,
    "tax": 15,
    "commission": 21
  },
  "debug": {
    "endorsements": [],
    "errors": [],
    "excesses": [],
    "exclusions": [],
    "indicators": {},
    "meta": {},
    "refers": [],
    "steps": {},
    "timer": []
  },
  "created_at": "2021-03-22T14:29:22.000Z"
}

Each quote has a unique quote_reference that is used within the quote request.

{
	"project_reference": "1085e088-5501-4cc0-babd-464c6ae04707",
	"version_reference": "862360ff-fe53-40e1-8f11-57bf9a6f7477",
	"quote_reference": "e8733d88-b560-44d4-8c03-b2366dfd2cbb",
	"meta": {
		"project_reference": "1085e088-5501-4cc0-babd-464c6ae04707",
		"version_reference": "862360ff-fe53-40e1-8f11-57bf9a6f7477",
		"quote_reference": "2ebc2426-772f-4f10-af63-25110554d35b",
		"company_reference": "098ae4f2-3af8-4740-8760-5d312e46742c",
		"version": 1
	},
	"output": {
		"commission": 31.46,
		"tax": 23.595,
		"result": 212.36,
		"valid": true
	},
	"input": {
	        "name": "smith",
	        "date_of_birth": "1990-01-01",
	        "country": "UK",
	        "duration_days": 5,
	        "is_healthy": true
	},
	"created_at": "2023-09-20T09:32:43.865Z",
	"debug": {}
}

Quote storage period

Different account types will store quotes for different periods of time.

Account Type

Period

Free

3 Months

Pay-as-you-go

12 Months

Professional

indefinitely

Enterprise

indefinitely

PreviousEndpoints Next/projects

Last updated 7 months ago