Starts onboarding for a partner at the connected stage (idempotent).

Onboarding record

POST /v1/partners/{id}/onboarding/start

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.edi.stateset.com/v1/partners/{id}/onboarding/start' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

{
  "blocker": "string",
  "created_at": "2026-08-31T14:22:05Z",
  "history": [
    {
      "actor": "string",
      "at": "2026-08-31T14:22:05Z",
      "from_stage": "connected",
      "note": "Two-person tent, green — replacement for damaged pole set.",
      "to_stage": "connected"
    }
  ],
  "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stage": "connected",
  "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "updated_at": "2026-08-31T14:22:05Z"
}

Path parameters

id · string · required

Partner ID

Request body

No request body.

Response

OnboardingRecord

blocker · string,null

When set, the partner is blocked at the current stage; advancing is refused until cleared.

created_at · string (date-time) · required

history · OnboardingEvent[] · required

Show OnboardingEvent

actor · string · required

Principal that made the change (admin, partner:{id}, or a system tag).

at · string (date-time) · required

from_stage · OnboardingStage,null

Ordered onboarding stages. Advancing moves one step along this sequence; the index is the source of truth for ordering. Allowed values: 'connected', 'profile_selected', 'mapped', 'testing', 'certified', 'live'.

note · string,null

to_stage · OnboardingStage · required

Ordered onboarding stages. Advancing moves one step along this sequence; the index is the source of truth for ordering. Allowed values: 'connected', 'profile_selected', 'mapped', 'testing', 'certified', 'live'.

partner_id · string · required

stage · OnboardingStage · required

Ordered onboarding stages. Advancing moves one step along this sequence; the index is the source of truth for ordering. Allowed values: 'connected', 'profile_selected', 'mapped', 'testing', 'certified', 'live'.

tenant_id · string · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	Onboarding record
404	Unknown partner

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.edi.stateset.com/v1/partners/{id}/onboarding/start' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

{
  "blocker": "string",
  "created_at": "2026-08-31T14:22:05Z",
  "history": [
    {
      "actor": "string",
      "at": "2026-08-31T14:22:05Z",
      "from_stage": "connected",
      "note": "Two-person tent, green — replacement for damaged pole set.",
      "to_stage": "connected"
    }
  ],
  "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stage": "connected",
  "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "updated_at": "2026-08-31T14:22:05Z"
}