{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aeae4604-eb34-4722-b103-15a2f614905a","name":"API Documentation","description":"Welcome to Aurae Health’s exclusive API documentation for partners, designed to streamline user onboarding, health risk assessments, and diagnostics integration. This API document enables seamless integration with our platform, offering instant data flow through secure webhooks for real-time updates and actionable insights.\n\n**For sample codes depending on your tech stack you can refer** [<b>here</b>](https://github.com/Onco-Connect-dev/Sample-Codes-Integration)\n\nKey Services:\n\n- **Employee Benefits Platform** → Complete Aurae Health White Labeled Platform which has Pharmacy , Teleconsultation , Diagnostics , All digital features Listed Below , Vision , Dental Inclinic Consultation.\n    \n- **Diagnostics** → Offers full access to Aurae Health’s diagnostics platform, enabling comprehensive medical testing and health assessments.\n    \n- **Face Vitals** → Uses AI to analyze facial features and extract vital health metrics, offering insights into overall wellness and potential health concerns.\n    \n- **Skin Analysis** -> Utilizes AI-driven analysis to detect your skin age ,wrinkles , acne etc .\n    \n- **Digital Fitness Assessment** → Assesses a user’s fitness level based on various physical and biometric parameters, providing personalized recommendations for improvement.\n    \n- **Body Composition Assessment** → Analyzes a user's body metrics such as fat percentage, muscle mass, and BMI to provide insights into overall physical health and targeted improvement strategies.\n    \n- **Posture Assessment** → Evaluates the user’s posture through visual and structural analysis to identify misalignments and suggest corrective exercises for better alignment and mobility.\n    \n- **Digital Health Assessment** → A comprehensive evaluation combining Posture, Body Composition, Fitness, and Face Vitals assessments to provide an all-around view of the user’s physical health and wellness.\n    \n- **Cancer Risk Assessment** → Analyzes user data to classify the risk of Bowel, Breast, Oral, Ovarian, Cervical, Lung, and Prostate Cancer into low, medium, or high-risk categories.\n    \n- **Health Risk Assessment** → Evaluates a user’s susceptibility to Diabetes, Kidney Disease, Stroke, Heart Disease, and Liver Disease, providing personalized risk insights.\n    \n- **Aurae Vision** → Utilizes AI-driven analysis to detect early signs of cataracts, helping users take preventive measures for better eye health.\n    \n\n# Development Environment Base URL\n\n**Note:** The current base URL for the **Development (DEV) environment** is:\n>\n> `https://dev-api.auraehealth.com`\n>\n> If you integrated with Aurae Health **before 01/09/2026**, you may currently be using the previous DEV environment URL:\n>\n> `https://qibi0hi1u6.execute-api.ap-south-1.amazonaws.com/dev`\n>\n> The API has now been moved to the new domain. **Both URLs will continue to work**, so existing integrations using the old URL will not be impacted.\n>\n> However, for all **new integrations, API documentation, and future references**, please use:\n>\n> `https://dev-api.auraehealth.com`\n  \n\n### Authentication & Access\n\nTo interact with these APIs, ensure you have valid API keys. Each request must include authentication headers for secure access.\n\nTo obtain an API key, please contact the **Onboarding Team at Aurae Health**. The API key is required to fetch an authentication token before accessing other endpoints.\n\n### Available Endpoints\n\nThe API consists of **POST** endpoints for user onboarding and **GET** endpoints for fetching report history.\n\nPlease Note that in Dev environment only 60 scans / assessments are allowed per service","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31798366","team":6794529,"collectionId":"aeae4604-eb34-4722-b103-15a2f614905a","publishedId":"2sAYdipAZB","public":true,"publicUrl":"https://docs.auraehealth.com","privateUrl":"https://go.postman.co/documentation/31798366-aeae4604-eb34-4722-b103-15a2f614905a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF798A"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Aurae Health API document"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/d9c12353-0ff8-461c-b22f-41a9ebd92b8b/TG9nb19wcmltYXJ5LnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"EF798A"}},{"name":"light","logo":"https://content.pstmn.io/3ecbdc78-deb9-45a7-806f-8a031b64037b/TG9nb19wcmltYXJ5LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF798A"}}]}},"version":"8.12.7","publishDate":"2026-08-21T05:14:16.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Aurae Health API document","description":""},"logos":{"logoLight":"https://content.pstmn.io/3ecbdc78-deb9-45a7-806f-8a031b64037b/TG9nb19wcmltYXJ5LnBuZw==","logoDark":"https://content.pstmn.io/d9c12353-0ff8-461c-b22f-41a9ebd92b8b/TG9nb19wcmltYXJ5LnBuZw=="}},"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/7bef0e11a5310023ade88b4b601df8f8a0cc9ee5d8718ea9775e7e557c94a456","favicon":"https://auraehealth.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"}],"canonicalUrl":"https://docs.auraehealth.com/view/metadata/2sAYdipAZB"}