API Reference v1.0
Last updated
Last updated
This operation provides a specific asset url of a specific scan.
The unique ID of the scan
unique-scan-id
The specific asset type of the scan
This operation provides the health report of a specific scan.
The unique ID of the scan
unique-scan-id
The unit system in which values will be returned
This operation provides the asset urls of a specific body shape prediction.
The unique ID of the body shape prediction
unique-body-shape-prediction-id
This operation registers a new user in hosted API. After a new user is registered, a scan for this user can be registered with /scans.
The email address of the user
foo@bar.com
A unique token for the user provided by the partner
unique-user-token
The user's weight
{"value":80,"unit":"kg"}
The user's height
{"value":1.8,"unit":"m"}
The user's sex
male
Available options: The user's region
north_america
Available options: The user's state of residence
California
The user's birth date
1990-01-01
Whether the user has consented to their data being used for research
true
The terms of service
{"accepted":true,"version":"1"}
This operation updates the meta data for a specific user.
A unique token for the user provided by the partner
unique-user-token
The email address of the user
foo@bar.com
A unique token for the user provided by the partner
unique-user-token
The user's weight
{"value":80,"unit":"kg"}
The user's height
{"value":1.8,"unit":"m"}
The user's sex
male
Available options: The user's region
north_america
Available options: The user's state of residence
California
The user's birth date
1990-01-01
Whether the user has consented to their data being used for research
true
This operation registers a new scan in hosted API.
A unique token for the user provided by the partner, that should be associated with the scan
unique-user-token
The name of the device configuration used for the scan
IPHONE_SCANNER
Available options: The asset configuration used for the scan
The requested bodyfat method for the scan
coco
Available options: This operation registers a new body shape prediction for a specific scan.
NOTE: Either a target weight or a target body fat percentage (but not both) must be specified
The unique ID of the scan on which the prediction should be based on
unique-scan-id
The prediction type that should be used for the prediction
weight_loss
Available options: The target weight (in kg) for the prediction. This or 'targetBodyfat' should be specified
50
The target body fat percentage for the prediction. This or 'targetWeight' should be specified
20