Skip to main content
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

public_key
string
required
Ed25519 public key of the agent (hex).
request_signature
MessageSignature
required
Signature proving ownership of public_key — see Authentication.
message GetOnboardingStatusRequest {
  string public_key = 1;
  MessageSignature request_signature = 30;
}

Response

status
OnboardingStatus
Current onboarding status.
party_id
string (optional)
Allocated Canton party ID, once assigned.
multihash
string (optional)
Multihash that must be signed with SubmitOnboardingSignature.
error_message
string (optional)
Populated if onboarding failed.
waiting_list_id
uint64
Waiting list position.

Next step

When multihash is populated, sign it locally and submit it with SubmitOnboardingSignature. Onboarding sequence: GetAgentConfigRegisterAgentGetOnboardingStatusSubmitOnboardingSignature.