Skip to main content

Getting Started

We offer either SDKs or APIs for access to our products. To get started, you must have an account with us and must request an API key. To get an API key, please contact our support team.

Note: Our self-serve portal to register a company account as well as users is still under development. Please reach out to our support team for assistance with setting up an account.

Registering a company

You must register a company account with us and enter in the following details:

  • Company Name
  • Phone
  • Address

Note: Registering a company account is mandatory for accessing our services through our API.

Creating users for your company (optional)

You can also create users in Helfie's system so you can store the results & assessments of users over time. To create a user, you will need to enter in the following details:

  • Name
  • Email
  • Date Of Birth
  • Gender
  • Height
  • Weight

You will then receive a user_id in the format of a UUID which you can use to make requests to our APIs. Example of a user_id: 22be54d0-c888-4b7c-a69b-59fd1bbef048. You can also retrieve historical measurements of this user by referencing this user_id.

Support​

If you need help, please contact our support team.