Initial integration
Fetch and visualise insights
introduction intelliprove offers multiple options for designing user experiences focused on health monitoring and visualising insights, making it easy for users to comprehend and interact with their health data head to our overview docid\ d z1x fglae 0r7hcnuth to learn more this guide will show you how to design a user flow and display the results according to your use case, using our rest api docid\ biupvixvhltbukklr2ati or widgets docid\ sxvsw2jfsohr7xbxeyz j prerequisites make sure to go through the first four steps of the getting started to understand how to register users and set up an initial integration of the plug in in your website or app initial integration docid\ qghldn2mla8w9rpkeigwn guide when a user performs a face scan, you can fetch the associated biomarkers using the api and the unique face scan id alternatively, you can use the user's id to fetch the biomarkers from their last face scan metrics, which are long term assessments based on multiple face scans, are available in the user's health profile to retrieve these metrics, you'll need the unique user id proceeding after the face scan when a user completes a face scan, your platform should respond appropriately for example, you could transition to a new page displaying the scan results or your health dashboard to determine when to proceed, listen for message events sent by the plug in for instance, the facescansuccessful message signals that the face scan was completed successfully and includes the face scan id refer to our message events documentation for more details about these events message events docid\ kz6xsnd6v4g8efcgd02ib it's important to note that you might also receive a userfinished event if the user ends the face scan without successfully completing it, for example, due to unfavorable conditions we recommend accounting for this in your page design, such as by adapting the content accordingly fetching health insights biomarkers to fetch biomarkers docid\ buhj nt45fuxcpges0qph , which are related to a specific face scan, you'll need the unique face scan id , obtained when the face scan was completed, or the user's id 1\ api rest api docid\ biupvixvhltbukklr2ati you can also request the rest api docid\ biupvixvhltbukklr2ati the user performed how do i obtain the face scan id? you can obtain the face scan id by listening to events generated by the plug in t he facescansuccessful event is generated when the face scan is completed successfully and signals that the results are ready the event json message contains the face scan id our message events documentation contains detailed information about the different types of message events that are sent by the plug in message events docid\ kz6xsnd6v4g8efcgd02ib 2\ widgets the biomarker widget displays the value of a specific biomarker from a user's face scan biomarker widget docid 3twbyjpm7m9a7dftx0xng metrics to fetch the user's health metrics docid\ yeqwskx81eju z8n3djhy , you'll need to specify the user this can be done using your own external user id , or the user id obtained from intelliprove when registering the user api the ' user health profiles ' endpoints allow you to fetch the metrics per health profile, as well as a feedback and tip message for every health profile rest api docid\ biupvixvhltbukklr2ati widgets the metric widget can be used to display the value of a specific metric from the user's health profile metric widget docid 6b 0cnu5cm5uyzx4jjbxp