Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

Create and manage users.

A User represents an end-customer whose body scans, 3D assets, and body composition metrics you manage through the Prism Hosted API. Each user can have multiple scans over time, which are linked to this user record.

All Users 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.

Register a new user.

post
/users

This operation creates a new user in the Hosted API. If a user with the same token already exists, their meta data is updated instead of creating a duplicate.

After a user is registered, you can create scans for this user with the /scans endpoint by providing the same token.

The token is the unique identifier of the user in your system. It must not contain an email address or any other personally identifiable information (PII).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
emailstring · email · nullableOptional

Deprecated. The email address of the user. Do not set this field in new integrations.

tokenstringRequired

A unique token for the user provided by the partner. Must not contain email addresses or other PII.

Example: unique-user-token
sexstring · enumRequired

The user's sex.

Example: malePossible values:
regionstring · enumRequired

The user's geographical region.

Example: north_americaPossible values:
usaResidencestringOptional

The user's U.S. state of residence, if applicable.

Example: California
birthDatestringRequired

The user's birth date (ISO date, format YYYY-MM-DD).

Example: 1990-01-01
researchConsentbooleanRequired

Indicates whether the user has consented to their data being used for research.

Example: true
Responses
201Success
application/json;v=1
idstringRequired

The unique ID of the user in the Prism Hosted API.

Example: unique-user-id
sexstring · enumRequired

The user's sex..

Example: malePossible values:
regionstring · enumRequired

The user's geographical region.

Example: north_americaPossible values:
usaResidencestring · nullableOptional

The user's U.S. state of residence, if applicable.

Example: California
birthDatestringRequired

The user's birth date (ISO date, format YYYY-MM-DD).

Example: 1990-01-01
tokenstringRequired

A unique token for the user provided by the partner. Must not contain email addresses or other PII.

Example: unique-user-token
emailstring · nullableOptional

Deprecated. The email address of the user. Do not set this field in new integrations.

researchConsentbooleanRequired

Indicates whether the user has consented to their data being used for research.

Example: true
post/users
POST /users HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "email": "",
  "token": "unique-user-token",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "researchConsent": true,
  "termsOfService": {
    "accepted": true,
    "version": "1"
  }
}
201Success
{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "",
  "researchConsent": true
}

Get meta data of a user.

get
/users/{token}

This operation returns the meta data of a specific user identified by the partner-provided token.

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>.
Path parameters
tokenstringRequired

A unique token for the user provided by the partner. It must not contain an email address or any other PII.

Example: unique-user-token
Query parameters
unit-systemstring · enumOptional

The unit system in which values will be returned.

Possible values:
Responses
200Success
application/json;v=1
idstringRequired

The unique ID of the user in the Prism Hosted API.

Example: unique-user-id
sexstring · enumRequired

The user's sex..

Example: malePossible values:
regionstring · enumRequired

The user's geographical region.

Example: north_americaPossible values:
usaResidencestring · nullableOptional

The user's U.S. state of residence, if applicable.

Example: California
birthDatestringRequired

The user's birth date (ISO date, format YYYY-MM-DD).

Example: 1990-01-01
tokenstringRequired

A unique token for the user provided by the partner. Must not contain email addresses or other PII.

Example: unique-user-token
emailstring · nullableOptional

Deprecated. The email address of the user. Do not set this field in new integrations.

researchConsentbooleanRequired

Indicates whether the user has consented to their data being used for research.

Example: true
get/users/{token}
GET /users/{token} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "",
  "researchConsent": true
}

Delete a user.

delete
/users/{token}

This operation deletes a specific user identified by the partner-provided token.

After deletion, the user can no longer be used for new scans or future me predictions.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenstringRequired

A unique token for the user provided by the partner. It must not contain an email address or any other PII.

Example: unique-user-token
Responses
200Success
application/json;v=1
idstringRequired

The unique ID of the user in the Prism Hosted API.

Example: unique-user-id
sexstring · enumRequired

The user's sex..

Example: malePossible values:
regionstring · enumRequired

The user's geographical region.

Example: north_americaPossible values:
usaResidencestring · nullableOptional

The user's U.S. state of residence, if applicable.

Example: California
birthDatestringRequired

The user's birth date (ISO date, format YYYY-MM-DD).

Example: 1990-01-01
tokenstringRequired

A unique token for the user provided by the partner. Must not contain email addresses or other PII.

Example: unique-user-token
emailstring · nullableOptional

Deprecated. The email address of the user. Do not set this field in new integrations.

researchConsentbooleanRequired

Indicates whether the user has consented to their data being used for research.

Example: true
delete/users/{token}
DELETE /users/{token} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "",
  "researchConsent": true
}

Update meta data of a user.

patch
/users/{token}

This operation updates the meta data of a specific user identified by the partner-provided token.

Send only the fields you want to change in the request body; all other fields remain unchanged. The token itself cannot be changed by this operation.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenstringRequired

A unique token for the user provided by the partner. It must not contain an email address or any other PII.

Example: unique-user-token
Body
emailstring · email · nullableOptional

Deprecated. The email address of the user. Do not set this field in new integrations.

tokenstringOptional

A unique token for the user provided by the partner. Must not contain email addresses or other PII.

Example: unique-user-token
sexstring · enumOptional

The user's sex.

Example: malePossible values:
regionstring · enumOptional

The user's geographical region.

Example: north_americaPossible values:
usaResidencestringOptional

The user's U.S. state of residence, if applicable.

Example: California
birthDatestringOptional

The user's birth date (ISO date, format YYYY-MM-DD).

Example: 1990-01-01
researchConsentbooleanOptional

Indicates whether the user has consented to their data being used for research.

Example: true
Responses
200Success
application/json;v=1
idstringRequired

The unique ID of the user in the Prism Hosted API.

Example: unique-user-id
sexstring · enumRequired

The user's sex..

Example: malePossible values:
regionstring · enumRequired

The user's geographical region.

Example: north_americaPossible values:
usaResidencestring · nullableOptional

The user's U.S. state of residence, if applicable.

Example: California
birthDatestringRequired

The user's birth date (ISO date, format YYYY-MM-DD).

Example: 1990-01-01
tokenstringRequired

A unique token for the user provided by the partner. Must not contain email addresses or other PII.

Example: unique-user-token
emailstring · nullableOptional

Deprecated. The email address of the user. Do not set this field in new integrations.

researchConsentbooleanRequired

Indicates whether the user has consented to their data being used for research.

Example: true
patch/users/{token}
PATCH /users/{token} HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "email": "",
  "token": "unique-user-token",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 80,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "researchConsent": true
}
200Success
{
  "id": "unique-user-id",
  "sex": "male",
  "region": "north_america",
  "usaResidence": "California",
  "birthDate": "1990-01-01",
  "weight": {
    "value": 80,
    "unit": "kg"
  },
  "targetWeight": {
    "value": 70,
    "unit": "kg"
  },
  "height": {
    "value": 1.8,
    "unit": "m"
  },
  "token": "unique-user-token",
  "email": "",
  "researchConsent": true
}

List terms acceptances of a user.

get
/users/{token}/terms

This operation returns all recorded terms of service acceptances for a specific user.

You identify the user by the partner-provided token in the path parameter. Use this endpoint to audit which terms versions a user has accepted and when.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenstringRequired

A unique token for the user provided by the partner. It must not contain an email address or any other PII.

Example: unique-user-token
Responses
200Success
application/json;v=1
userIdstringRequired
userTokenstringRequired
acceptedbooleanRequired
versionstring · nullableRequired
acceptanceDatestringRequired
get/users/{token}/terms
GET /users/{token}/terms HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "userId": "text",
    "userToken": "text",
    "accepted": true,
    "version": "text",
    "acceptanceDate": "text"
  }
]

Create a terms acceptance for a user.

post
/users/{token}/terms

This operation records a terms of service acceptance for a specific user.

You identify the user by the partner-provided token in the path parameter. Provide the version of the terms in the request body; the API stores the acceptance state and timestamp.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tokenstringRequired

A unique token for the user provided by the partner. It must not contain an email address or any other PII.

Example: unique-user-token
Body
versionstringOptional
Responses
201Success
application/json;v=1
userIdstringRequired
userTokenstringRequired
acceptedbooleanRequired
versionstring · nullableRequired
acceptanceDatestringRequired
post/users/{token}/terms
POST /users/{token}/terms HTTP/1.1
Host: api.hosted.prismlabs.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "version": "text"
}
201Success
{
  "userId": "text",
  "userToken": "text",
  "accepted": true,
  "version": "text",
  "acceptanceDate": "text"
}
PreviousPrism Hosted API
NextScans

Last updated