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

Onboarding record

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

cURL

curl --request POST \
  --url 'https://edi.stateset.com/v1/partners/{id}/onboarding/start' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "blocker": "string",
  "created_at": "2026-08-31T14:22:05Z",
  "history": [
    {
      "actor": "string",
      "at": "2026-08-31T14:22:05Z",
      "from_stage": {
        "0": "c",
        "1": "o",
        "2": "n",
        "3": "n",
        "4": "e",
        "5": "c",
        "6": "t",
        "7": "e",
        "8": "d"
      },
      "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

Response

OnboardingRecord

blocker · string

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 · object

note · string

to_stage · OnboardingStage · required

partner_id · string · required

stage · OnboardingStage · required

tenant_id · string · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	Onboarding record
404	Unknown partner

cURL

curl --request POST \
  --url 'https://edi.stateset.com/v1/partners/{id}/onboarding/start' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "blocker": "string",
  "created_at": "2026-08-31T14:22:05Z",
  "history": [
    {
      "actor": "string",
      "at": "2026-08-31T14:22:05Z",
      "from_stage": {
        "0": "c",
        "1": "o",
        "2": "n",
        "3": "n",
        "4": "e",
        "5": "c",
        "6": "t",
        "7": "e",
        "8": "d"
      },
      "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"
}