{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6fc103e2-5120-4ba1-9962-e0271be1d36b","name":"Treppy API","description":"# Treppy API Platform\n\nTreppy REST API Platform lets agents integrate with Treppy to get valid lists of plans and quotes to support various customer journeys. This could be anything from a chatbot flow to custom forms.\n\n## Understanding the APIs at a Glance\n\nThe 3 main categories of the platform: 1) Plans, 2) Quotes, and 3) Purchase (Future Release).\n\n### Browse Plans\n\nBuild inventory of available plans with `/plans`. All plans are associated with a Plan Category. Within the Plan Category you'll find plans and plan details. The plan schema is the same for all categories.\n\n### Quotes\n\nWith trip details passed in the request, you can get a quote within a _plan category_ with `/quote/{Plan_Category}/`. Difference plan categories have different request body parameters.\n\n### Purchase\n\nToday, with `v1`, a plan has a `purchase_form_link` attribute, which will take the user through the existing UI for your subdomain when they follow the link. The form UI is already developed. Customers will fill out the form, payment details are encrypted and sent to the insurance company for processing.\n\nIn the future, we will release APIs to purchase directly. The future API will allow you to customize the look and flow for your check out process.\n\n## Getting Started with Quotes\n\nCustomer quotes is the workhorse of your business. Customers will need to supply details about travelers and their trips. Different types of insurance, called _plan categories_, have different types of required inputs in the request body. You'll get a quote object response.\n\nThe _Quote Object_ will have a unique id per quote request. It will include the category, trip details passed earlier, timestamps and _plan items_. Each _ plan item_ will have descriptions, enumeration values for coverage and deductible amounts in US Dollars (USD), options, restrictions, and premiums. Premiums are the cost of a plan for a requested trip of travelers, in USD.\n\n### Working with policy coverage limits and deductibles.\n\nThe plan maximum coverage limit, `policy_max_options`, is the main object used to get a premium. This array contains maximum coverage objects with a nested array of deductible options for each available `max_coverage` object. Not all deductible options are available in all maximum coverage amounts, even for the same plan. Deductibles can vary in availability for each maximum coverage amount. You need to display appropriate deductible choices to customers based on the policy maximum coverage selected. \\[See the `[Schemas\\MaxCoverage_Response]`\\] for additional clarity.\n\n### Workflow\n\n1. Collect data from the customer in the request body\n    \n2. `POST` the required data collected from a customer with `/quote/{category}`.\n    \n3. Parse the response for your UI\n    \n4. Display quoted items.\n    \n\n### Update a single _Quote Plan Item_ with new policy max coverage or deductible\n\nYou can update a single item with new policy max and or deductible with `/quote/{Quote_ID}/{Plan_ID}`. This is a quick response for a new quote for just the plan passed. You will get a new quote id.\n\n### Special Plans and Options\n\nSome plans have additional required options to be selected. Some plans will have additional options available as an add- on. In `[Schemas/QuotePlanItemResponse]` is `plan_options` array containing `pre_existing`, if available. In the future there will be additional options.\n\nIf the customer _must_ also select a `pre_existing` item, the object will contain `\"required\": true`, otherwise any option here is not required (`\"required\": false`). `pre_existing` will have one or more objects to choose from, which are dependent upon `selected_policy_max` and `selected_deductible` . `selected_pre_existing` notes the default selected option, if required.\n\nAs of v1, special plans are INF Elite and INF Premier plans. INF Advantage has an optional add-on for acute onset of pre-existing conditions.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9137568","team":744105,"collectionId":"6fc103e2-5120-4ba1-9962-e0271be1d36b","publishedId":"TWDWJxAx","public":true,"publicUrl":"https://docs.api.treppy.io","privateUrl":"https://go.postman.co/documentation/9137568-6fc103e2-5120-4ba1-9962-e0271be1d36b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-01-02T18:27:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/209f1e9eef307fb30ec6745040fe9585f781af4ebd3725562a37820d3137c73f","favicon":"https://res.cloudinary.com/postman/image/upload/v1648761087/team/t2zs4tjqnj315givxs4e.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.api.treppy.io/view/metadata/TWDWJxAx"}