{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ca7857b4-4d33-4472-939a-22d7c70b8b3c","name":"API Reference","description":"# Alteos\n\n**Alteos** is a B2B & B2C platform for creating and managing insurance products and policies.\n\n## Quick Start\n\nFollow the steps below for the quickest way to integrate with Alteos:\n\n### 0\\. API credentials\n\nBefore you start using Alteos API you have to request application key (**AlteosAppKey**). Additionaly you will need access key ID (**AlteosAccessKeyId**) and access key secret (**AlteosAccessKeyId**) for Server-to-Server integration or access key ID (**AlteosAccessKeyId**) together with email/password ( (**AccountEmail/AccountPassword**) for Browser-to-Server integration\n\n### 1\\. Authenticate to our platform\n\nFor Server-to-Server authentication go [here](#dc362cba-10b2-4a0a-bae4-737b4b9fed0c), for Browser-to-Server authentication go [here](#dfee47d3-def6-47b8-b279-83f4697187f0)\n\nEvery request to Alteos' API should have **X-App-Key** header set.\n\n```\nX-App-Key: <AlteosAppKey>\n\n ```\n\nOnce authenticated, pass the received data in the authorization header\n\n```\nAuthorization: <AlteosAccessTokenType> <AlteosAccessToken>\n\n ```\n\nfor each subsequent request.\n\nThe **AlteosAccessToken** token has a limited life-time. To request new **AlteosAccessToken** token use [Renew endpoint](#ff10fca1-8d14-495e-abae-616b3f6a6c9b).\n\n### 2.a Quote policy\n\nTo get a price quote for a policy, provide relevant data to the [Policy Quotation](#e765ae65-7fab-4939-8d71-8727e610d708) endpoint: all the parameters/fields which **contribute to the price calculation**, plus the selected insurance package and add-ons (if present).\n\nOn success, the quote details will be received in the response payload, broken down into net premium and insurance tax (before and after discounts). Additionally, the request data is also included in the response.\n\nThe quote step is optional and it doesn’t generate any policy, it only provides the calculated premium for the selected package, parameters and add-ons.\n\nThe subsequent steps are normally: **policy creation, policy payment, policy document retrieval**.\n\n### 2.b Create policy\n\nTo create a policy, provide product relevant data to the [Policy Creation](#95050dbe-f343-4cf4-a286-1832563d1205) endpoint: this includes the parameters necessary for quotation, plus all the rest of fields that define the product (including customer data).\n\nOn success, the **policy ID** will be received in the response payload, together with request data and quote details.\n\nAfter this step, the policy is created but it is **not yet in an active state**.\n\nIn order to \"activate\" the contract, it is necessary to **trigger the payment** for the policy.\n\n### 2.c Pay policy\n\nTo perform the SEPA payment of the insurance policy previously created, it is necessary to provide information about the **IBAN** of the bank account to be charged, as well as the **name of the account holder**. SEPA is currently the only processing type supported in the [Policy Payment](#0831afbc-756f-40ca-8539-edc10d6e0a4c) endpoint.\n\nOn success, the **policy ID** will be returned in the response payload.\n\nAt this point, the contract status is fully activated (issued). After this step, the **policy documents** are generated (eg. \"Versicherungsschein\", AGB documents etc) and can be retrieved via a separate endpoint (see step 2.d).\n\n### 2.d Fetch policy documents\n\nThe endpoint for retrieving all [Policy Documents](#98bc584f-d6fd-4577-a37a-8b49ffa9a8d4) for a specified policy ID can be called after the contract has been issued (i.e. after successful policy creation and payment).\n\nIt returns for each file the **name and URL under which the document is hosted and can be downloaded**. Currently only PDF files are supported; they are not encoded nor archived.\n\n### 3\\. That's it\n\nAt this point you should be integrated with Alteos. There are some additional endpoints that might be of importance to you. Please explore the documentation further.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5329358","collectionId":"ca7857b4-4d33-4472-939a-22d7c70b8b3c","publishedId":"RzZAjyNv","public":true,"publicUrl":"https://docs.api.alteos.com","privateUrl":"https://go.postman.co/documentation/5329358-ca7857b4-4d33-4472-939a-22d7c70b8b3c","customColor":{"top-bar":"2064BE","right-sidebar":"242728","highlight":"F6A906"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-11-01T13:39:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Sandbox","id":"049c87e8-f7f2-4419-a3c2-bb68bfb5687c","owner":"5270105","values":[{"key":"apiDomain","value":"https://api.sandbox.alteos.com","enabled":true},{"key":"accessToken","value":"...","enabled":false},{"key":"appKey","value":"{{AlteosAppKey}}","enabled":true},{"key":"apiKey","value":"{{ApiKey}}","enabled":true},{"key":"authorizationHeader","value":"{{AlteosAccessTokenType}} {{AlteosAccessToken}}","enabled":true}],"published":true}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://alteos.com/favicon.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"},{"label":"Sandbox","value":"5270105-049c87e8-f7f2-4419-a3c2-bb68bfb5687c"}],"canonicalUrl":"https://docs.api.alteos.com/view/metadata/RzZAjyNv"}