The IntelliProve API is your one-stop shop for extracting biomarkers and obtaining insights from facial video data. These API docs describe how to integrate our API into your platform and obtain an objective look into mental and physical health status.

As a customer, you will receive information about environment to use for testing or production from us.

All the endpoints described below require an API key or a Auth0 bearer token in the header for authentication purposes.

Use this endpoint to retrieve user information for the current user. The user information defines to which user group and customer you belong.

Get user details

Use this endpoint to check wether your video measurement conditions are qualified to perform a measurement. Take a snapshot image of the video preview, with the patient in the frame and upload this via formdata. Our custom quality check algorithm will return a quality score for your current measurement setup.

In case your conditions are met, you will receive a quality score greater or equal to 5. You can safely start a measurement with the current conditions.

Insufficient lighting or bad framing will result in quality score that is lower than 5. Follow the instructions in the prompt property or check the quality error code for more information.

Check conditions

The table below gives an overview of the different possible error codes with corresponding explanation.

Get a temporary URL and credentials for our S3 bucket, which you can use to upload your video measurement. Mind that these credentails are only valid for 300 seconds. Furthermore, the upload size is restricted to 150MB.

Get upload URL

 properties from the response to upload the video.

Upload a video, so that it is ready to be processed. The video should be uploaded as multipart/form-data to the URL you obtained above. Use the form fields from the previous response and add these as form data parameters to the POST request.

Upload video

Use this endpoint to add the uploaded video, specified by it's uuid, to the processing queue. Once done, our IntelliProve processing engine will start extracting the biomarkers.
Use the "/results/wait" endpoint to get the results.

Process video

Use these endpoints to obtain results for a specific health check or a group of health checks, based on patient reference and performer reference.

Get the results of a single health check, by specifying the UUID of the measurement. The request long-polls the database for up to 20 seconds, returning the results as soon as they are available or returning a http 204 if no results were found after this time has expired. 

Get results

Use this endpoint to get your number of successfully performed measurements. It also returns the number of allowed measurement for your current contract.

Note that the query parameter 'performer-ref' is only used for admin users to filter on the measurements performed by a given performer.

Quality Error Code	Description
0	No error.
1	You're too close to the camera.
2	You're too far away. Move closer.
3	You're not centered horizontally in the frame.
4	Your chest is not visible.
5	Look straight into the camera.
6	Insufficient lighting.
7	Patient skin not visible. Make sure the forehead is cleared.

Property	Description
uuid	Unique reference key for the uploaded video.
url	Upload URL to the S3 Bucket.
formFields	Form-properties for multipart uploading to the S3 Bucket.

API docs

IntelliProve API

Environments

Authentication

API Key

Auth0 Bearer Token

OpenAPI spec

Auth endpoints

Videos endpoints

Results endpoints