Initial integration

introduction this is the technical documentation to get started with the intelliprove solution, targeted at developers a stepwise approach to get started quickly is given in the next section an initial integration of the intelliprove plug in to perform face scans can typically be done in about one hour for an overview of the different concepts, functionalities and features referred to in this documentation, refer to the overview docid\ d z1x fglae 0r7hcnuth notice this documentation correponds to the latest version of the intelliprove api (v2) transitioning to v2? check out our migrating from v1 to v2 docid\ rpdctbtelzpsgqu8lt8oj if you are still using intelliprove api v1 and want to revisit the docs, please refer to plug in docid\ f86cembkuj kwr60rtrev you can verify your version by checking the api base url if it contains "v1," you are on the v1 version of our api getting started 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 every user is assigned a unique user id face scan refers to a single scan performed by a user each scan is identified by a unique face scan id face scan docid\ mw6gpbzekcj lzrqjll biomarkers biomarkers are health insights associated with a single face scan more detailed info can be found biomarkers docid\ buhj nt45fuxcpges0qph metrics metrics are health insights derived from the analysis of multiple face scans and organized in a health profile associated with each user metrics docid\ yeqwskx81eju z8n3djhy by associating face scans with users, intelliprove ensures accurate tracking and meaningful health insights the relation between the different objects is displayed in the figure below integrating the face scan the standardized flow consists of five simple steps this integrates intelliprove in your platform and allows your users to perform face scans and check the corresponding results 1\ "perform scan" button this one is simple add a cta button or something similar in your app's frontend, so that users can start the face scan when the user clicks this button, you need to trigger a few actions which are necessary to display the plug in this includes creating a user, requesting an authenticated url for the plug in, and embedding the plug in in your frontend these steps are detailed below 2\ create user each face scan is directly linked to a user intelliprove identifies users through a unique id therefore, to request a face scan url, the user performing the scan must be registered on intelliprove's side this only needs to be done once for each user to create a user, use the api and provide a unique id for the user in the query parameter external user id this is an id you choose yourself the response of the call will contain the intelliprove user id , which is the pseudonimized user id intelliprove uses internally to keep track of the user's face scans and health profile rest assured no data directly linking to the person (for example, name or social security number) is stored by intelliprove! you can use either the external user id or the user id in other api calls when specifying the user in other api endpoints post /v2/users rest api docid\ biupvixvhltbukklr2ati 3\ request authenticated plug in url to embed the face scan plug in within your web platform or mobile app and let users perform face scans, you will need an authenticated url linked to the user you can request this url via the api, providing the user id in the request the url that is returned is linked to the specific user this means that the results of the face scan performed with that url, will be saved under the corresponding user's profile important a fresh url should be requested every time a user wants to perform a face scan one url = one face scan get /v2/userjourneys/scan plug in url docid\ wcs2y1mg2pqnl4r4mgg z 4\ display and hide face scan plug in you can now embed the face scan plug in within your web platform or mobile app, providing the url from the previous step use an iframe or one of our sdks to embed the plug in we provide detailed guides to embed the plug in, based on your platform embed plug in docid\ rfjkpqxvj2uchau2ib184 once the plug in is embedded in your platform, you can perform your first face scan! dismiss the plug in when the scan completes the plug in communicates to your parent app when the face scan completes – using web post messages – so that you can dismiss the plug in and continue the flow in your app message events docid\ kz6xsnd6v4g8efcgd02ib 5\ request health insights you can request the the biomarkers related to the latest face scan(s) of the user via the api this allows you to use them in your own backend logic and perform additional actions based on the outcomes get /v2/face scans/latest rest api docid\ biupvixvhltbukklr2ati alongside the results determined during a specific face scan (i e the biomarkers), intelliprove also provides longer term, deeper assessments, i e the user's health metrics these are organized in the user's user health profile docid\ z2qnaeg2ru 3t3hbhw8rh get /v2/userprofiles/\ profile rest api docid\ biupvixvhltbukklr2ati for more information, refer to our dedicated page for fetching and visualizing health metrics fetch and visualise insights docid\ f2 0ikisgfy3c5l181vv9 visualizing the results using widgets optionally, you can use our widgets docid\ sxvsw2jfsohr7xbxeyz j to display the results customizing the plug in's ui want to customise the ui/ux of the solution? white labelling docid\ vzz odplrstmbhthzklld