> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# One partner's onboarding record.

> Onboarding record

### Path parameters

<ParamField path="id" type="string" required>
  Partner ID
</ParamField>

### Response

`OnboardingRecord`

<ResponseField name="blocker" type="string">
  When set, the partner is blocked at the current stage; advancing is refused until cleared.
</ResponseField>

<ResponseField name="created_at" type="string (date-time)" required />

<ResponseField name="history" type="OnboardingEvent[]" required>
  <Expandable title="OnboardingEvent">
    <ResponseField name="actor" type="string" required>
      Principal that made the change (`admin`, `partner:&#123;id&#125;`, or a system tag).
    </ResponseField>

    <ResponseField name="at" type="string (date-time)" required />

    <ResponseField name="from_stage" type="object" />

    <ResponseField name="note" type="string" />

    <ResponseField name="to_stage" type="OnboardingStage" required />
  </Expandable>
</ResponseField>

<ResponseField name="partner_id" type="string" required />

<ResponseField name="stage" type="OnboardingStage" required />

<ResponseField name="tenant_id" type="string" required />

<ResponseField name="updated_at" type="string (date-time)" required />

### Status codes

| Code  | Meaning                |
| ----- | ---------------------- |
| `200` | Onboarding record      |
| `404` | Onboarding not started |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://edi.stateset.com/v1/partners/{id}/onboarding' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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"
  }
  ```
</ResponseExample>