Update the onboarding status for a user

PATCH /onboarding/{userId}/status

Parameters

userId string Required path

The unique ID of a user. Same as the id field returned by GET /users/me (or by any list endpoint under /users). Log in first, call /users/me, copy id.

status enum Required

No description.

Possible values: pendingcompletedapprovedrejected

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

rejectionReason string

No description.

curl -X PATCH "https://heimdall.qa.zoniqx.com/onboarding/<userId>/status" \ -H "Authorization: Bearer <accessToken>" \ -H "x-tenant-id: <your-tenant-id>" \ -H "Content-Type: application/json" \ -d '{ "status": "pending", "rejectionReason": "string" }'

const response = await fetch("https://heimdall.qa.zoniqx.com/onboarding/<userId>/status", { method: "PATCH", headers: { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "status": "pending", "rejectionReason": "string" }), }); const data = await response.json();

type OnboardingController_updateStatusResponse = Record<string, unknown>; const response = await fetch("https://heimdall.qa.zoniqx.com/onboarding/<userId>/status", { method: "PATCH", headers: { Authorization: "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", "Content-Type": "application/json", }, body: JSON.stringify({ "status": "pending", "rejectionReason": "string" }), }); const data: OnboardingController_updateStatusResponse = await response.json();

import requests url = "https://heimdall.qa.zoniqx.com/onboarding/<userId>/status" headers = { "Authorization": "Bearer <accessToken>", "x-tenant-id": "<your-tenant-id>", } payload = { "status": "pending", "rejectionReason": "string" } response = requests.patch(url, headers=headers, json=payload) data = response.json()