Introduction
Section titled “Introduction”Refer to the general Rest API documentation. Link here.
Authentication
Section titled “Authentication”| API Key | Action Token | |
|---|---|---|
| Purpose | For admin calls (e.g. requesting action tokens) | For client operations (e.g. quality checks) |
| Header key | x-api-key | Authorization |
| Header value | “<your_API_key>” | “Token <your_action_token>” |
Refer to the general Rest API documentation for more information. Link here.
Errors
Section titled “Errors”Refer to the general Rest API documentation on how to handle unhappy HTTP Status Codes. Link here.
Smart Care Limitations
Section titled “Smart Care Limitations”- We will not define “Users” (as described here in the general API documentation)
- Why? The concept of users implies that each patient has a seperate login and builds a user profile, tracking the person over time and learning insights. This concept is currently beyond the scope of this project.
Endpoints
Section titled “Endpoints”Action token
POSThttps://engine.intelliprove.com/v1/smartcare/authenticate
Request an action token for client-side usage.
Header parameters
x-api-keystring | required | Valid API key. |
Body parameters
valid_minutesinteger | optional | Validity for the action token, expressed in minutes. Default = 360 minutes (6 hours) |
Request
{ "valid_minutes": 360}Response
{ "token": "eyJhbGciOiJIUzI1NiIsInR5...", "expires_utc": "2025-06-03T16:22:02.820552+00:00"}Image quality check
POSThttps://engine.intelliprove.com/v1/smartcare/check
Perform the IntelliProve image quality check on a single JPEG image, sent as multipart/form-data.
Header parameters
Authorizationstring | required | Valid action token in the format: "Token <your_action_token>". |
Form data parameters
imageobject | required | JPEG-compressed image sent as a binary stream with the MIME type image/jpeg. |
Response
{ "error_code": int, "error_type": string}error_code | error_type | Description |
|---|---|---|
| 1 | TOO_CLOSE | You’re too close, move further away from the camera. |
| 2 | TOO_FAR | You’re too far, move closer to the camera. |
| 3 | NOT_CENTERED | Align and center your face with the indication frame. |
| 4 | NO_CHEST | Your upper chest is not visible enough, make sure it’s in the indicated frame. |
| 5 | BAD_POSE | Look straight to the camera. |
| 6 | BAD_LIGHTING | Good lightning is important. Make sure your face is well lit and the light is evenly spread on your face. Use the flash function if needed. |
| 7 | FOREHEAD_OUT_FRAME | Make sure your forehead is within the indicated frame. |
| 8 | NO_FACE_DETECTED | We couldn’t detect a face. Make sure you are in the indication frame and lighting is good. |
| 9 | NO_FOREHEAD_SKIN | We couldn’t detect enough qualitative skin area on your forehead. Please ensure it’s visible, and the lighting on your face is evenly spread. Try again! |
Get Upload URL
POSThttps://engine.intelliprove.com/v1/smartcare/uploads/request-url
Get pre-signed upload URL for uploading the ZIP files via a multipart/form-data POST request.
Header parameters
Authorizationstring | required | Valid action token in the format: "Token <your_action_token>". |
Response
{ "face_scan_id": "dbb1dfe2-8d3b-4b6b-abc6-74b3829be89d", "expiry_time_seconds": 3600, "url": "https://intelliprove-main-streaming-bucket-develop.s3.amazonaws.com/", "method": "POST", "content_type": "multipart/form-data", "fields": { "key": "smartcare/dbb1dfe2-8d3b-4b6b-abc6-74b3829be89d.zip", "x-amz-algorithm": "AWS4-HMAC-SHA256", "x-amz-credential": "AKIA23BCDYDWR7PSCEKZ/20250709/eu-west-1/s3/aws4_request", "x-amz-date": "20250709T075856Z", "policy": "eyJleHBpcmF0aW9uIjogIjIwMjUtMDctMDlUMDg6NTg6NTZaIiwgImNvbmRpdGlvbnMiOiBbeyJrZXkiOiAic21hcnRjYXJlL2RiYjFkZmUyLThkM2ItNGI2Yi1hYmM2LTc0YjM4MjliZTg5ZC56aXAifSwgWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsIDAsIDYwMDAwMDAwXSwgeyJidWNrZXQiOiAiaW50ZWxsaXByb3ZlLW1haW4tc3RyZWFtaW5nLWJ1Y2tldC1kZXZlbG9wIn0sIHsia2V5IjogInNtYXJ0Y2FyZS9kYmIxZGZlMi04ZDNiLTRiNmItYWJjNi03NGIzODI5YmU4OWQuemlwIn0sIHsieC1hbXotYWxnb3JpdGhtIjogIkFXUzQtSE1BQy1TSEEyNTYifSwgeyJ4LWFtei1jcmVkZW50aWFsIjogIkFLSUEyM0JDRFlEV1I3UFNDRUtaLzIwMjUwNzA5L2V1LXdlc3QtMS9zMy9hd3M0X3JlcXVlc3QifSwgeyJ4LWFtei1kYXRlIjogIjIwMjUwNzA5VDA3NTg1NloifV19", "x-amz-signature": "c49efa351f4b5fd49d87deaf3707776dba1e913eca7a2f2806edeef4cab54674" }}Refer to the ZIP File Format documentation on how to format the ZIP file and content.
Trigger Processing
POSThttps://engine.intelliprove.com/v1/smartcare/uploads/process
Asynchronously trigger the processing of a specific health scan UUID (fire-and-forget) when the ZIP file is found valid.
Header parameters
Authorizationstring | required | Valid action token in the format: "Token <your_action_token>". |
Body parameters
face_scan_idstring | required | Face Scan UUID. |
patient_dataobject | required | Dynamic JSON object for storing patient data. |
local_timezonestring | optional | An optional time zone to use for the time based metrics. Defaults to "Europe/Brussels" |
Request
{ "face_scan_id": "832151dc-1b68-4077-97b0-88454f695653", "patient_data": { "ead": "abc-123456789" }, "metadata": { "field1": "value1" }}Get FHIR resources
GEThttps://engine.intelliprove.com/v1/smartcare/fhir/all
Get FHIR collection of all resources created between the given time interval.
Query parameters
fromstring | required | Return all FHIR resources performed starting from this datetime. ISO format (e.g. "2025-09-09T00:00:00") |
untilstring | optional | Return all FHIR resources until this datetime. ISO format (e.g. "2025-09-10T00:00:00"). Leave out to default to "now". |
Header parameters
x-api-keystring | required | Valid API key. |
Request
// EmptyResponse
{ "resourceType": "Bundle", "type": "collection", "entry": [ { "resourceType": "Observation", ... }, { "resourceType": "Observation", ... }, ... ]}
