POST
/
assessment
/
api
/
v1
/
init
/

​
API Details

Authorizations

auth
string
headerrequired

The authentication token of the developer (generated using Authorization API).

Headers

client-id
string
required

Any unique string to identify the logged in developer.

locale
enum<string>

Locale is used to determine the language of the assessment. Supported locales are en, hi, kn for english, hindi and kannada respectively with default being en.

Available options:
en,
hi,
kn

Body

application/json

The request body should contain the user information. Users can either provide the date of birth or age using dob and age fields respectively, along with gender inside user_info.

user_info
object
required

The user information should contain atleast the age of the user.

workflow_id
integer
default: 1000required

A unique id to identify the assessment to be taken. Detailed list of Assessment Workflows

practitioner_id
string

A unique practitioner id to identify the practitioner to associate an assessment with, if applicable.

patient_id
string

A unique patient id to identify the patient to associate as assessment with, if applicable.

Response

200 - application/json

The response object contains the assessment_id that uniquely identifies the assessment session.

assessment_id
string
required

A unique identifier for the assessment session.

🚀 Getting StartedStep 2. Start Assessment