Add a single contact with one or more vehicles. Get insurance products available for the contacts vehicle including price, term and other key information. Register the sale of one or more policies.
\nAn optional URL can be returned which authenticates and redirects the user to a page where more information is required to complete the policy registration.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10886525","collectionId":"5bf44125-3cfd-4fe8-a59f-f5a98d56d421","publishedId":"T17AkBbE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-10-22T09:51:24.000Z"},"item":[{"name":"Create contact and vehicle(s)","id":"8035ba85-0ed4-47f8-8443-f135eb67007c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"x-bearer-token xxxxxxxxxxxxxx"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"createContactVehicle\": {\r\n\t\t\"dealerId\": 12345,\r\n\t\t\"returnUrlToRecord\": false,\r\n\t\t\"customer\": {\r\n\t\t\t\"title\": \"Miss\",\r\n\t\t\t\"firstName\": \"Emma\",\r\n\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\"dateOfBirth\": \"1990-11-10\",\r\n\t\t\t\"line1\": \"62 Something Avenue\",\r\n\t\t\t\"line2\": \"Bridge End\",\r\n\t\t\t\"line3\": \"Warwick\",\r\n\t\t\t\"line4\": \"Warwickshire\",\r\n\t\t\t\"line5\": \"West of England\",\r\n\t\t\t\"postcode\": \"CV72 9RD\",\r\n\t\t\t\"homeTelephone\": \"0123456789\",\r\n\t\t\t\"mobileTelephone\": \"07712345678\",\r\n\t\t\t\"email\": \"emma.smith@email.co.uk\",\r\n\t\t\t\"companyName\": \"Company name Ltd\",\r\n\t\t\t\"type\": \"Private Limited Company\"\r\n\t\t},\r\n\t\t\"vehicle\": [\r\n\t\t\t{\r\n\t\t\t\t\"vrm\": \"AB12CDE\",\r\n\t\t\t\t\"make\": \"HYUNDAI\",\r\n\t\t\t\t\"model\": \"IX35 SE NAV 4WD CRDI\",\r\n\t\t\t\t\"style\": \"ESTATE\",\r\n\t\t\t\t\"fuelType\": \"DIESEL\",\r\n\t\t\t\t\"colour\": \"SILVER\",\r\n\t\t\t\t\"vinNumber\": \"HRDHTRE232153\",\r\n\t\t\t\t\"engineCapacity\": 1995,\r\n\t\t\t\t\"vehicleType\": \"CAR/LCV\",\r\n\t\t\t\t\"saleType\": \"Used vehicle\",\r\n\t\t\t\t\"deliveryDate\": \"2020-06-20\",\r\n\t\t\t\t\"firstRegistered\": \"2016-11-10\",\r\n\t\t\t\t\"currentMileage\": 56123,\r\n\t\t\t\t\"annualMileage\": 10000,\r\n\t\t\t\t\"vehiclePrice\": 8995.99,\r\n\t\t\t\t\"fourWheelDrive\": false,\r\n\t\t\t\t\"turboCharged\": false,\r\n\t\t\t\t\"manufacturersWarranty\": false,\r\n\t\t\t\t\"optionalCover\": {\r\n\t\t\t\t\t\"SatNavMediaCommandCenter\": true,\r\n\t\t\t\t\t\"poweredRoof\": false,\r\n\t\t\t\t\t\"catalyticConverter\": true\r\n\t\t\t\t}\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"vrm\": \"YE15GTS\",\r\n\t\t\t\t\"make\": \"BMW\",\r\n\t\t\t\t\"model\": \"330i SE 4WD \",\r\n\t\t\t\t\"style\": \"ESTATE\",\r\n\t\t\t\t\"fuelType\": \"PETROL\",\r\n\t\t\t\t\"colour\": \"RED\",\r\n\t\t\t\t\"vinNumber\": \"TTGAU81VNFJ752654\",\r\n\t\t\t\t\"engineCapacity\": 2995,\r\n\t\t\t\t\"vehicleType\": \"CAR/LCV\",\r\n\t\t\t\t\"saleType\": \"Used vehicle\",\r\n\t\t\t\t\"deliveryDate\": \"2020-06-20\",\r\n\t\t\t\t\"firstRegistered\": \"2016-11-10\",\r\n\t\t\t\t\"currentMileage\": 12500,\r\n\t\t\t\t\"annualMileage\": 5000,\r\n\t\t\t\t\"vehiclePrice\": 25000.00,\r\n\t\t\t\t\"fourWheelDrive\": false,\r\n\t\t\t\t\"turboCharged\": true,\r\n\t\t\t\t\"manufacturersWarranty\": false,\r\n\t\t\t\t\"optionalCover\": {\r\n\t\t\t\t\t\"SatNavMediaCommandCenter\": true,\r\n\t\t\t\t\t\"poweredRoof\": false,\r\n\t\t\t\t\t\"catalyticConverter\": true\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}"},"url":"https://spectrum-test.suvoki.com/spectrum/api/v1/create/contact/vehicle","description":"Create a quote with a single contact having one or more vehicles. Optionaly return a URL which authenticates the user and redirects to the quotes product configuration page.
\nThe response will include the contact id, vehicle id(s) and optional URL if the property \"returnUrlToRecord\" is true.
\n","urlObject":{"protocol":"https","path":["spectrum","api","v1","create","contact","vehicle"],"host":["spectrum-test","suvoki","com"],"query":[],"variable":[]}},"response":[{"id":"ad1be198-f145-4620-a90c-99be4b1c3951","name":"Create contact and vehicle(s)","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"x-bearer-token xxxxxxxxxxxxxx"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"createContactVehicle\": {\r\n\t\t\"dealerId\": 12345,\r\n\t\t\"returnUrlToRecord\": false,\r\n\t\t\"customer\": {\r\n\t\t\t\"title\": \"Miss\",\r\n\t\t\t\"firstName\": \"Emma\",\r\n\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\"dateOfBirth\": \"1990-11-10\",\r\n\t\t\t\"line1\": \"62 Something Avenue\",\r\n\t\t\t\"line2\": \"Bridge End\",\r\n\t\t\t\"line3\": \"Warwick\",\r\n\t\t\t\"line4\": \"Warwickshire\",\r\n\t\t\t\"line5\": \"West of England\",\r\n\t\t\t\"postcode\": \"CV72 9RD\",\r\n\t\t\t\"homeTelephone\": \"0123456789\",\r\n\t\t\t\"mobileTelephone\": \"07712345678\",\r\n\t\t\t\"email\": \"emma.smith@email.co.uk\",\r\n\t\t\t\"companyName\": \"Company name Ltd\",\r\n\t\t\t\"type\": \"Private Limited Company\"\r\n\t\t},\r\n\t\t\"vehicle\": [\r\n\t\t\t{\r\n\t\t\t\t\"vrm\": \"AB12CDE\",\r\n\t\t\t\t\"make\": \"HYUNDAI\",\r\n\t\t\t\t\"model\": \"IX35 SE NAV 4WD CRDI\",\r\n\t\t\t\t\"style\": \"ESTATE\",\r\n\t\t\t\t\"fuelType\": \"DIESEL\",\r\n\t\t\t\t\"colour\": \"SILVER\",\r\n\t\t\t\t\"vinNumber\": \"HRDHTRE232153\",\r\n\t\t\t\t\"engineCapacity\": 1995,\r\n\t\t\t\t\"vehicleType\": \"CAR/LCV\",\r\n\t\t\t\t\"saleType\": \"Used vehicle\",\r\n\t\t\t\t\"deliveryDate\": \"2020-06-20\",\r\n\t\t\t\t\"firstRegistered\": \"2016-11-10\",\r\n\t\t\t\t\"currentMileage\": 56123,\r\n\t\t\t\t\"annualMileage\": 10000,\r\n\t\t\t\t\"vehiclePrice\": 8995.99,\r\n\t\t\t\t\"fourWheelDrive\": false,\r\n\t\t\t\t\"turboCharged\": false,\r\n\t\t\t\t\"manufacturersWarranty\": false,\r\n\t\t\t\t\"optionalCover\": {\r\n\t\t\t\t\t\"SatNavMediaCommandCenter\": true,\r\n\t\t\t\t\t\"poweredRoof\": false,\r\n\t\t\t\t\t\"catalyticConverter\": true\r\n\t\t\t\t}\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"vrm\": \"YE15GTS\",\r\n\t\t\t\t\"make\": \"BMW\",\r\n\t\t\t\t\"model\": \"330i SE 4WD \",\r\n\t\t\t\t\"style\": \"ESTATE\",\r\n\t\t\t\t\"fuelType\": \"PETROL\",\r\n\t\t\t\t\"colour\": \"RED\",\r\n\t\t\t\t\"vinNumber\": \"TTGAU81VNFJ752654\",\r\n\t\t\t\t\"engineCapacity\": 2995,\r\n\t\t\t\t\"vehicleType\": \"CAR/LCV\",\r\n\t\t\t\t\"saleType\": \"Used vehicle\",\r\n\t\t\t\t\"deliveryDate\": \"2020-06-20\",\r\n\t\t\t\t\"firstRegistered\": \"2016-11-10\",\r\n\t\t\t\t\"currentMileage\": 12500,\r\n\t\t\t\t\"annualMileage\": 5000,\r\n\t\t\t\t\"vehiclePrice\": 25000.00,\r\n\t\t\t\t\"fourWheelDrive\": false,\r\n\t\t\t\t\"turboCharged\": true,\r\n\t\t\t\t\"manufacturersWarranty\": false,\r\n\t\t\t\t\"optionalCover\": {\r\n\t\t\t\t\t\"SatNavMediaCommandCenter\": true,\r\n\t\t\t\t\t\"poweredRoof\": false,\r\n\t\t\t\t\t\"catalyticConverter\": true\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://spectrum-test.suvoki.com/spectrum/api/v1/create/contact/vehicle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jul 2020 13:40:05 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) PHP/7.0.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Debug-Token","value":"6a2c39"},{"key":"X-Debug-Token-Link","value":"/_profiler/6a2c39"},{"key":"Content-Length","value":"38"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactId\": 21803,\n \"vehicleId\": [\n 3028,\n 3029\n ]\n}"}],"_postman_id":"8035ba85-0ed4-47f8-8443-f135eb67007c"},{"name":"List products","id":"6f7dea35-d43e-422c-a31f-7d7b098d8bd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"x-bearer-token xxxxxxxxxxxxxx"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"insuranceProducts\": {\r\n \"dealerId\": 12345,\r\n \"contactId\": 21803,\r\n \"vehicleId\": 3029\r\n }\r\n}"},"url":"https://spectrum-test.suvoki.com/spectrum/api/v1/list/products","description":"List insurance products available for the contacts vehicle including price, term and other key information.
\nThe response will include information required to register the sale of one or more policies.
\n","urlObject":{"protocol":"https","path":["spectrum","api","v1","list","products"],"host":["spectrum-test","suvoki","com"],"query":[],"variable":[]}},"response":[{"id":"382ff524-5758-4ccf-9372-5ffcb07b3553","name":"List products","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"x-bearer-token xxxxxxxxxxxxxx"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"insuranceProducts\": {\r\n \"dealerId\": 12345,\r\n \"contactId\": 21803,\r\n \"vehicleId\": 3029\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://spectrum-test.suvoki.com/spectrum/api/v1/list/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jul 2020 13:34:26 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) PHP/7.0.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Debug-Token","value":"49d628"},{"key":"X-Debug-Token-Link","value":"/_profiler/49d628"},{"key":"Content-Length","value":"602"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"productVariants\": [\n {\n \"id\": \"5387\",\n \"insurerName\": \"Acasta\",\n \"productVariantName\": \"Gold\",\n \"rateName\": \"Gold\",\n \"claimLimit\": \"500\",\n \"term\": \"7\"\n },\n {\n \"id\": \"5388\",\n \"insurerName\": \"Acasta\",\n \"productVariantName\": \"Gold\",\n \"rateName\": \"Gold\",\n \"claimLimit\": \"500\",\n \"term\": \"7\"\n },\n {\n \"id\": \"5389\",\n \"insurerName\": \"Acasta\",\n \"productVariantName\": \"Gold\",\n \"rateName\": \"Gold\",\n \"claimLimit\": \"500\",\n \"term\": \"7\"\n },\n {\n \"id\": \"4446\",\n \"insurerName\": \"Acasta\",\n \"productVariantName\": \"RPP GAP\",\n \"rateName\": \"RPP GAP\",\n \"claimLimit\": \"PPOV\",\n \"term\": \"49\"\n },\n {\n \"id\": \"4452\",\n \"insurerName\": \"Acasta\",\n \"productVariantName\": \"RPP GAP\",\n \"rateName\": \"RPP GAP\",\n \"claimLimit\": \"PPOV\",\n \"term\": \"37\"\n }\n ]\n}"}],"_postman_id":"6f7dea35-d43e-422c-a31f-7d7b098d8bd3"},{"name":"Register policy","id":"8b2a3466-0818-45be-8bd8-ab45e334d98e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"x-bearer-token xxxxxxxxxxxxxx"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"policyRegistration\": {\r\n\t\t\"dealerId\": 12345,\r\n\t\t\"vehicleId\": 3029,\r\n\t\t\"products\": [\r\n\t\t\t{\r\n\t\t\t\t\"productVariantId\": 5387,\r\n\t\t\t\t\"startDate\": \"2021-03-11\",\r\n\t\t\t\t\"salePrice\": 300.00,\r\n\t\t\t\t\"isMonthly\": false\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"productVariantId\": 5388,\r\n\t\t\t\t\"startDate\": \"2021-03-11\",\r\n\t\t\t\t\"salePrice\": 150.01,\r\n\t\t\t\t\"isMonthly\": true\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}"},"url":"https://spectrum-test.suvoki.com/spectrum/api/v1/register/policy","description":"Register the sale of one or more policies.
\n","urlObject":{"protocol":"https","path":["spectrum","api","v1","register","policy"],"host":["spectrum-test","suvoki","com"],"query":[],"variable":[]}},"response":[{"id":"d2b57fee-8cc2-45b7-acc4-c15417ca049f","name":"Register policy","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"x-bearer-token xxxxxxxxxxxxxx"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"policyRegistration\": {\r\n\t\t\"dealerId\": 12345,\r\n\t\t\"vehicleId\": 3029,\r\n\t\t\"products\": [\r\n\t\t\t{\r\n\t\t\t\t\"productVariantId\": 5387,\r\n\t\t\t\t\"startDate\": \"2020-05-26\",\r\n\t\t\t\t\"salePrice\": 35.99,\r\n\t\t\t\t\"isMonthly\": true\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"productVariantId\": 5388,\r\n\t\t\t\t\"startDate\": \"2020-05-26\",\r\n\t\t\t\t\"salePrice\": 120.00,\r\n\t\t\t\t\"isMonthly\": false\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://spectrum-test.suvoki.com/spectrum/api/v1/register/policy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jul 2020 13:39:13 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) PHP/7.0.33"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.0.33"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Debug-Token","value":"00a7ff"},{"key":"X-Debug-Token-Link","value":"/_profiler/00a7ff"},{"key":"Content-Length","value":"62"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"clientId\": \"21803\",\n \"vehicleId\": \"3029\",\n \"policy\": [\n 5697,\n 5698\n ]\n}"}],"_postman_id":"8b2a3466-0818-45be-8bd8-ab45e334d98e"}],"event":[{"listen":"prerequest","script":{"id":"2a60c42e-9fbd-46b3-a5f5-667a59fa8e89","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e38bbdb-a56e-4362-837b-2adc01c9023d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"authorisation-token","value":"xxxxxxxxxxxxxx"}]}