Getting started

this guide walks you through the essential steps to get started by the end, you will have implemented a basic intelliprove integration that enables users to perform face scans and view their results in your app key objects in intelliprove four primary types of objects are central to intelliprove's functionality user represents a unique end user accessing intelliprove's services each user must be created once, enabling intelliprove to track their face scans and build a personalized user health profile docid\ biupvixvhltbukklr2ati face scan refers to a single scan performed by a user each scan is identified by a unique face scan id docid\ mw6gpbzekcj lzrqjll biomarkers biomarkers are health insights associated with a single face scan they are measurable, objective physiological indicators docid\ buhj nt45fuxcpges0qph metrics metrics are interpreted health insights derived from the analysis of multiple face scans and incorporating contextual information docid\ yeqwskx81eju z8n3djhy by associating face scans with users, intelliprove ensures accurate tracking and meaningful health insights the relationships between these objects are illustrated in the figure below integrating the face scan 1\ "perform scan" button add a clear call to action (cta) button in your app’s frontend that allows users to start a face scan when the user clicks this button, you’ll need to execute a few steps to display the plug in correctly these steps include creating a user requesting an authenticated plug in url embedding the plug in in your frontend each of these steps is explained in detail below 2\ create user each face scan must be linked to a user intelliprove identifies a user using a unique external user id – an identifier you choose before requesting a face scan url, ensure the user exists you can either check via the docid\ biupvixvhltbukklr2ati api endpoint, or simply attempt to docid\ biupvixvhltbukklr2ati if the user already exists, the api will return the stored user record to create a user, call the api with your chosen external user id the response includes intelliprove’s internal user id , a pseudonymized identifier used to track face scans and health profiles intelliprove does not store personally identifiable information such as names or national identifiers you can use either external user id or user id in subsequent api calls post /v2/users docid\ biupvixvhltbukklr2ati 3\ request face scan plug in url to display the face scan plug in in a web or mobile app, you must request an authenticated url linked to the user provide the user id to the api, and it will return a url that is tied to the specific user collects results under that user's profile is valid for one face scan only a new url must be requested for each scan one url = one scan get /v2/userjourneys/scan docid\ wcs2y1mg2pqnl4r4mgg z 4\ display and hide the face scan plug in use the url returned in the previous step to embed the face scan plug in into your app you can integrate the plug in using an iframe , or one of intelliprove’s sdks , depending on your platform we provide detailed guides to embed the plug in, based on your platform docid\ rfjkpqxvj2uchau2ib184 once embedded, users can perform their first face scan! dismissing the plug in when a scan is completed, the plug in sends a postmessage event to the parent app so you can hide/dismiss the plug in and continue your flow postmessages safely enable cross origin communication between window objects and allow your app to stay up to date on progress within the face scan plug in docid\ kz6xsnd6v4g8efcgd02ib 5\ visualize health insights once scans are performed, you can present health insights to your users or request the raw results data intelliprove offers several integration options, which you can also combine depending on your needs fastest option the health dashboard embed a complete dashboard that visualizes biomarkers and metrics with minimal setup – similar to embedding the face scan plug in flexible option widgets use our intelliwidgets, prebuilt ui components that behave like modular tiles, allowing for a more tailored presentation of the results full custom option api use our api to access raw results data this lets you integrate the outputs into your own backend logic, trigger follow up actions, or feed them into your recommendation engine or other analysis workflows the ideal approach for visualizing health insights depends on your use case and application we provide detailed guides for each option docid\ f2 0ikisgfy3c5l181vv9 customizing the ui you can customize the styling and appearance of the plug in and widgets to match your platform docid\ vzz odplrstmbhthzklld