Developers
V1MeOnboarding

Start a signed-in session on the current revision, idempotent per account and revision

Optional goals/preferences only. This functional setup state does not grant health, social, analytics or marketing consent. A retry returns the existing session even after its revision is archived.

POST
/v1/me/onboarding

Authorization

bearer
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/me/onboarding" \  -H "Content-Type: application/json" \  -d '{    "revisionId": "bae12d01-48af-47b3-9304-b09ef0081cd6",    "locale": "en-MY"  }'
{  "revision": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "status": "draft",    "version": 1,    "definition": {      "name": "string",      "slides": [        {          "id": "string",          "title": {            "en-MY": "string",            "ms-MY": "string",            "zh-Hans-MY": "string"          },          "body": {            "en-MY": "string",            "ms-MY": "string",            "zh-Hans-MY": "string"          },          "image": {            "url": "http://example.com",            "alt": {              "en-MY": "string",              "ms-MY": "string",              "zh-Hans-MY": "string"            }          }        }      ],      "questions": [        {          "id": "string",          "prompt": {            "en-MY": "string",            "ms-MY": "string",            "zh-Hans-MY": "string"          },          "kind": "single",          "options": [            {              "id": "string",              "label": {                "en-MY": "string",                "ms-MY": "string",                "zh-Hans-MY": "string"              }            },            {              "id": "string",              "label": {                "en-MY": "string",                "ms-MY": "string",                "zh-Hans-MY": "string"              }            }          ],          "maxSelections": 1        }      ]    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "publishedAt": "2019-08-24T14:15:22Z"  },  "progress": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "revisionId": "bae12d01-48af-47b3-9304-b09ef0081cd6",    "version": 1,    "status": "in_progress",    "locale": "en-MY",    "stepId": "string",    "seenSlideIds": [      "string"    ],    "answers": {      "property1": [        "string"      ],      "property2": [        "string"      ]    },    "startedAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z"  }}

Read your latest setup session and its pinned definition GET

Previous Page

Download your setup sessions and their original questions as portable JSON GET

Owner-only, up to 100 sessions per page. Follow nextCursor until null. This is separate from clinical passport readings; no public download URL is created.