website logo
IntelliProve
Insights & Biomarkers
API documentation
SDK Documentation
Navigate through spaces
IntelliProve
Insights & Biomarkers
API documentation
SDK Documentation
⌘K
API docs
API flow
Docs powered by archbee 

API docs



IntelliProve API

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.

Environments

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

Authentication

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

API Key

Auth0 Bearer Token

OpenAPI spec

Auth endpoints

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
200
401
|

Videos endpoints

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: Technical requirements

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
200
401
422
|

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

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.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
200
401
406
|

Use the url and form_data_fields properties from the response to upload the video.

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.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
204
400
403
|

The sequence of the form parameters is of importance for the AWS authentication flow. Please preserve the order as listed above.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
200
401
404
406
|

Results endpoints

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: Insights & biomarkers

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
200
204
401
420
|
Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get
Curl
Node.js
JS
Python
Ruby
|
RESPONSES
200
401
|
UP NEXT
API flow
Docs powered by archbee 
Get user details
TABLE OF CONTENTS
IntelliProve API
Environments
Authentication
API Key
Auth0 Bearer Token
OpenAPI spec
Auth endpoints
GET
Get user details
Videos endpoints
POST
Check conditions
GET
Get upload URL
POST
Upload video
POST
Process video
Results endpoints
GET
Get results
GET
Get count