Start Onboarding

post

https://ingest.spektr.com/v1/public/actions/processId/{processId}/workspaceId/{workspaceId}

Creates a new onboarding session for your client. You can optionally prefill client data by submitting a payload in the request body. The response includes a session token that you can append to the onboarding URL: https://actions.spektr.com/form?token={token} to direct your client to the onboarding flow. If using a custom domain, replace actions.spektr.com with your domain.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

processId

string

required

The ID of the onboarding process template

workspaceId

string

required

The ID of your workspace

Query Params

reference

string

Your custom reference ID to track this onboarding session or it can be included in the data payload

Body Params

data

object

Client information to prefill in the onboarding forms (optional)

Headers

idempotency-key

string

Optional unique key (1–255 chars) to ensure the request is processed only once. If a duplicate key is sent with the same request parameters, the original response is replayed. Replayed responses include the idempotent-replayed: true header.

x-spektr-block-until-ready

string

Set to 'true' to have the server wait until the onboarding session is ready to accept a submission before responding, so the returned token can be submitted immediately without client-side polling. Defaults to false.

Responses

409

A request with this idempotency-key is currently being processed

422

idempotency-key has already been used with different request parameters

201Onboarding session created successfully

400Invalid input parameters