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.
Auth0 Bearer Token
Use these routes to:
Get an upload URL, for uploading a video to be processed;
Process uploaded videos in order to obtain mental biomarkers;
Perform quality checks in order to assess video quality, health check setup and environment
Keep the technical requirements in mind during video recording. See:
The table below gives an overview of the different possible error codes with corresponding explanation.
Quality Error Code
You're too close to the camera.
You're too far away. Move closer.
You're not centered horizontally in the frame.
Your chest is not visible.
Look straight into the camera.
Patient skin not visible. Make sure the forehead is cleared.
Use the url and form_data_fields properties from the response to upload the video.
Unique reference key for the uploaded video.
Upload URL to the S3 Bucket.
Form-properties for multipart uploading to the S3 Bucket.
The sequence of the form parameters is of importance for the AWS authentication flow. Please preserve the order as listed above.
Use these endpoints to obtain results for a specific health check or a group of health checks, based on patient reference and performer reference.
More information about the returned biomarkers and insights can be found on the following page: