GetOnboardingStatus

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

string

required

Ed25519 public key of the agent (hex).

MessageSignature

required

Signature proving ownership of public_key — see Authentication.

message GetOnboardingStatusRequest {
  string public_key = 1;
  MessageSignature request_signature = 30;
}

Response

OnboardingStatus

Current onboarding status.

string (optional)

Allocated Canton party ID, once assigned.

string (optional)

Multihash that must be signed with SubmitOnboardingSignature.

string (optional)

Populated if onboarding failed.

uint64

Waiting list position.

Next step

When multihash is populated, sign it locally and submit it with SubmitOnboardingSignature. Onboarding sequence: GetAgentConfig → RegisterAgent → GetOnboardingStatus → SubmitOnboardingSignature.

RegisterAgent SubmitOnboardingSignature

⌘I

Introduction

Core (read-only)

Transfer

Preapproval

Fee Payment

DvP (Delivery vs Payment)

CIP-56 Tokens

Recurring Payments

Onboarding

MultiCall

User Service

Bridge

GetOnboardingStatus

Request

Response

Next step

​Request

​Response

​Next step

Request

Response

Next step