Scans

Create and manage body scans for users.

Each scan generates body measurements, body composition metrics, various 3D and image assets, and can further generate Future Me predictions. Scans are always linked to a specific user and can be created, queried, and deleted independently of other scans.

Common configurations:

Default Native Pipeline: assetConfigId == "25f6d3a6-a634-40c3-8452-0342bee242d0"
Default Web Pipeline: assetConfigId == "ee651a9e-6de1-4621-a5c9-5d31ca874718"
Legacy Native Pipeline: assetConfigId == "c979ab6b-e46b-4c1c-89e1-bb02435b5cbf"

All Scans endpoints require the following headers:

accept: application/json;v=1
authorization: Bearer {{API_KEY}}
content-type: application/json

Replace {{API_KEY}} with your Prism API key for the selected environment.

List scans.

get

/scans

This operation returns a paginated list of scans available for a specific user identified by the partner-provided token.

Use the limit, cursor, and order query parameters to control pagination behavior.

Optionally, you can use the unit-system query parameter to receive values in metric or imperial units.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:

orderstring · enumOptional

Sorting order used for pagination. Determines how the cursor is applied (for example, ascending or descending by creation time).

Possible values:

cursorstringOptional

Cursor pointing to the position in the scan list from which the next page should start. Usually taken from the previous response.

limitnumberOptional

Maximum number of scans to return in a single page.

Example: 20

Responses

200Success

application/json;v=1

get

/scans

GET /scans HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{}

Register a new scan.

post

/scans

This operation registers a new scan in the Hosted API for an existing user.

To associate the scan with the correct user, provide the same token in the request body that you used when registering the user via the /users endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

userTokenstringRequired

The partner-provided unique user token associated with this scan.

Example: unique-user-token

deviceConfigNamestring · enumRequired

The device configuration used to capture this scan.

Example: IPHONE_SCANNERPossible values:

assetConfigIdstring · uuidOptional

The asset configuration applied to this scan.

Use this ID to control which assets (models, images, etc.) are generated for the scan.

Common configurations:

Default Native Pipeline: assetConfigId == "25f6d3a6-a634-40c3-8452-0342bee242d0"
Default Web Pipeline: assetConfigId == "ee651a9e-6de1-4621-a5c9-5d31ca874718"
Legacy Native Pipeline: assetConfigId == "c979ab6b-e46b-4c1c-89e1-bb02435b5cbf"

Example: 25f6d3a6-a634-40c3-8452-0342bee242d0

bodyfatMethodstring · enumOptional

The body fat method applied to this scan.

Example: cocoPossible values:

Responses

201Success

application/json;v=1

post

/scans

POST /scans HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "userToken": "unique-user-token",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "25f6d3a6-a634-40c3-8452-0342bee242d0",
  "bodyfatMethod": "coco"
}

201Success

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "25f6d3a6-a634-40c3-8452-0342bee242d0",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1,
    "forearmLeftFit": 1,
    "forearmRightFit": 1,
    "wristLeftFit": 1,
    "wristRightFit": 1,
    "bmiPredicted": 1,
    "bmiConfidence": 1,
    "bodyRoundnessIndex": 1,
    "fullBodyVolume": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64,
    "vatPercentage": 1.5,
    "vatMass": 1.2,
    "appendicularLeanMassPercentage": 20,
    "appendicularLeanMass": 16,
    "skeletalMuscleMassPercentage": 20,
    "skeletalMuscleMass": 16
  }
}

Get status of a scan.

get

/scans/{id}

This operation provides the current status and details of a specific scan.

Use this endpoint to poll the processing status after registering a scan or to retrieve its latest state for display in your application.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the scan.

Example: unique-scan-id

Query parameters

unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:

Responses

200Success

application/json;v=1

get

/scans/{id}

GET /scans/{id} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "25f6d3a6-a634-40c3-8452-0342bee242d0",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1,
    "forearmLeftFit": 1,
    "forearmRightFit": 1,
    "wristLeftFit": 1,
    "wristRightFit": 1,
    "bmiPredicted": 1,
    "bmiConfidence": 1,
    "bodyRoundnessIndex": 1,
    "fullBodyVolume": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64,
    "vatPercentage": 1.5,
    "vatMass": 1.2,
    "appendicularLeanMassPercentage": 20,
    "appendicularLeanMass": 16,
    "skeletalMuscleMassPercentage": 20,
    "skeletalMuscleMass": 16
  }
}

Delete a scan.

delete

/scans/{id}

This operation deletes a specific scan.

After deletion, the scan and its associated data are no longer available for retrieval or reporting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the scan.

Example: unique-scan-id

Responses

200Success

application/json;v=1

delete

/scans/{id}

DELETE /scans/{id} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "unique-scan-id",
  "status": "PROCESSING",
  "prismScanId": "prism-unique-scan-id",
  "deviceConfigName": "IPHONE_SCANNER",
  "assetConfigId": "25f6d3a6-a634-40c3-8452-0342bee242d0",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "userId": "unique-user-id",
  "userToken": "unique-user-token",
  "createdAt": "text",
  "updatedAt": "text",
  "scanAssets": {
    "id": "unique-scan-asset-id",
    "scanId": "unique-scan-id",
    "captureData": "succeeded",
    "captureDataUpdatedAt": "text",
    "body": "started",
    "bodyUpdatedAt": "text",
    "fittedBody": null,
    "fittedBodyUpdatedAt": "text",
    "measurement": null,
    "measurementUpdatedAt": "text",
    "createdAt": "text",
    "updatedAt": "text"
  },
  "measurements": {
    "neckFit": 1,
    "shoulderFit": 1,
    "upperChestFit": 1,
    "chestFit": 1,
    "lowerChestFit": 1,
    "waistFit": 1,
    "waistNavyFit": 1,
    "stomachFit": 1,
    "hipsFit": 1,
    "upperThighLeftFit": 1,
    "upperThighRightFit": 1,
    "thighLeftFit": 1,
    "thighRightFit": 1,
    "lowerThighLeftFit": 1,
    "lowerThighRightFit": 1,
    "calfLeftFit": 1,
    "calfRightFit": 1,
    "ankleLeftFit": 1,
    "ankleRightFit": 1,
    "midArmRightFit": 1,
    "midArmLeftFit": 1,
    "lowerArmRightFit": 1,
    "lowerArmLeftFit": 1,
    "waistToHipRatio": 1,
    "forearmLeftFit": 1,
    "forearmRightFit": 1,
    "wristLeftFit": 1,
    "wristRightFit": 1,
    "bmiPredicted": 1,
    "bmiConfidence": 1,
    "bodyRoundnessIndex": 1,
    "fullBodyVolume": 1
  },
  "bodyfat": {
    "bodyfatMethod": "coco",
    "bodyfatPercentage": 20,
    "leanMassPercentage": 80,
    "fatMass": 16,
    "leanMass": 64,
    "vatPercentage": 1.5,
    "vatMass": 1.2,
    "appendicularLeanMassPercentage": 20,
    "appendicularLeanMass": 16,
    "skeletalMuscleMassPercentage": 20,
    "skeletalMuscleMass": 16
  }
}

Get upload URL for a scan.

post

/scans/{scanId}/upload-url

This operation provides a pre-signed upload URL for a specific scan.

Use the returned URL to upload the capture data for this scan directly with a PUT request to Prism.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scanIdstringRequired

The unique ID of the scan.

Example: unique-scan-id

Responses

201Success

application/json;v=1

post

/scans/{scanId}/upload-url

POST /scans/{scanId}/upload-url HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

201Success

{
  "expirationTime": "text",
  "url": "https://signed-url"
}

PreviousUsers NextScans Assets

Last updated 1 day ago

hashtagCreate and manage body scans for users.

hashtagList scans.

hashtagRegister a new scan.

hashtagGet status of a scan.

hashtagDelete a scan.

hashtagGet upload URL for a scan.

Create and manage body scans for users.

List scans.

Register a new scan.

Get status of a scan.

Delete a scan.

Get upload URL for a scan.