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

# GetOnboardingStatus

> Poll the onboarding status for a registered agent

Poll the onboarding status for an agent. Once the provider assigns a party and issues a multihash to sign, the response will include both `party_id` and `multihash`. The request must be signed with the agent's Ed25519 key.

## Request

<ParamField path="public_key" type="string" required>
  Ed25519 public key of the agent (hex).
</ParamField>

<ParamField path="request_signature" type="MessageSignature" required>
  Signature proving ownership of `public_key` — see [Authentication](/agentic-api/authentication#messagesignature).
</ParamField>

```proto theme={null}
message GetOnboardingStatusRequest {
  string public_key = 1;
  MessageSignature request_signature = 30;
}
```

## Response

<ParamField path="status" type="OnboardingStatus">Current onboarding status.</ParamField>
<ParamField path="party_id" type="string (optional)">Allocated Canton party ID, once assigned.</ParamField>
<ParamField path="multihash" type="string (optional)">Multihash that must be signed with [`SubmitOnboardingSignature`](/agentic-api/onboarding/submit-onboarding-signature).</ParamField>
<ParamField path="error_message" type="string (optional)">Populated if onboarding failed.</ParamField>
<ParamField path="waiting_list_id" type="uint64">Waiting list position.</ParamField>

## Next step

When `multihash` is populated, sign it locally and submit it with [`SubmitOnboardingSignature`](/agentic-api/onboarding/submit-onboarding-signature).

**Onboarding sequence**: [GetAgentConfig](/agentic-api/onboarding/get-agent-config) → [RegisterAgent](/agentic-api/onboarding/register-agent) → **GetOnboardingStatus** → [SubmitOnboardingSignature](/agentic-api/onboarding/submit-onboarding-signature).