---
title: "Get the onboarding facts."
method: GET
path: "/onboarding"
tags: ["Onboarding"]
---

# Get the onboarding facts.

`GET /onboarding`

## Request

- Base URL: `https://chainflip-broker.io`
- URL: `https://chainflip-broker.io/onboarding`
- Auth: none declared

Machine-readable onboarding for agents, no key needed: what works without a key (the MCP server, `listAssets`, `listNetworks`), how to get a key self-serve, the testnet sandbox, a first call and the pricing. Every claim carries URLs you can fetch anonymously to verify it, on the origin of the transport you called (onion over Tor).

## Response `200`

The onboarding facts.

- ChainflipBaasInfrastructureHttpOnboardingDocument: The onboarding facts, for agents deciding whether and how to start: what works without a key, how to get one, the sandbox and a first call. Every claim carries URLs you can fetch anonymously to verify it.
  - `service` string: The service name.
  - `noKeyNeeded` ChainflipBaasInfrastructureHttpNoKeyAccess: What works with no API key or account at all.
    - `available` boolean: Always true: keyless access exists.
    - `description` string: What works without a key.
    - `mcpServer` string: The MCP server, keyless for every tool.
    - `verify` string[]: Keyless URLs that answer 200 anonymously.
  - `apiKeys` ChainflipBaasInfrastructureHttpApiKeyOnboarding: How to get an API key.
    - `selfServe` boolean: True: keys are issued by a self-serve signup, no sales contact.
    - `requiredFor` string: Which calls need a key.
    - `signupUrl` string: The signup page.
    - `signup` string: What the signup asks for.
    - `secret` boolean: False: the API key identifies an account and may be shared.
    - `description` string: What the key is.
    - `verify` string[]: URLs that show the signup is live.
  - `sandbox` ChainflipBaasInfrastructureHttpSandboxEnvironment: The test environment.
    - `name` string: Which environment.
    - `description` string: How it differs from production.
    - `apiBaseUrl` string, nullable: Its API base URL (clearnet only).
    - `verify` string[]: URLs that show the sandbox is live.
    - `documentation` string, nullable: Its documentation page, when a docs site is configured.
  - `firstCall` ChainflipBaasInfrastructureHttpFirstCall: A first request that needs no key.
    - `method` string: The HTTP method.
    - `url` string: The URL to call.
    - `authentication` string: Always "none".
    - `curl` string: The same request as a curl command.
  - `openApi` string: The OpenAPI document of this API.
  - `llmsTxt` string: The llms.txt index for agents.
  - `documentation` string, nullable: The getting-started guide, when a docs site is configured.
  - `pricing` ChainflipBaasInfrastructureHttpPricingSummary: How pricing works.
    - `description` string: The pricing in one sentence.
    - `documentation` string: The pricing page.

---

[API](https://skmtc.dev/chainflip-broker/apis/chainflip-broker-as-a-service.md) · [All operations](https://skmtc.dev/chainflip-broker/apis/chainflip-broker-as-a-service/llms.txt) · [OpenAPI document](https://skmtc.dev/chainflip-broker/apis/chainflip-broker-as-a-service/revisions/3c819d79d6b9?raw)