# Brickken Documentation

- [Brickken Developer Documentation](https://docs.brickken.com/index.md): Tokenize real-world assets and give AI agents on-chain authority, through one API.
- [What you can do](https://docs.brickken.com/get-started/what-you-can-do.md): Every capability the Brickken APIs expose, and which client can reach it.
- [Choose your surface](https://docs.brickken.com/get-started/choose-your-surface.md): Five ways to call the same Brickken backend — and which one fits what you are building.
- [Sandbox](https://docs.brickken.com/get-started/sandbox.md): Fund a test wallet, reach the right storefront, and create a test investor without a KYC document.
- [API Challenge — Hello World](https://docs.brickken.com/get-started/build-programme/api-hello-world.md): Create and verify your first tokenized asset with the Brickken Dapp API.
- [Agentic Challenge — Hello World](https://docs.brickken.com/get-started/build-programme/agentic-hello-world.md): Register an ERC-8004 agent and deploy its token with the Brickken CLI.
- [Quickstart](https://docs.brickken.com/get-started/quickstart.md): Make your first Brickken call on whichever surface you picked.
- [Request BKN from the Faucet](https://docs.brickken.com/api-reference/endpoint/bkn-faucet.md): Request 100 BKN on Ethereum Sepolia with an API key or a 0.01 USDC x402 payment.
- [Dapp API](https://docs.brickken.com/api-reference/introduction.md): API-key authenticated Brickken API for tokenization, STOs, security-token operations, and reads.
- [Postman Collection](https://docs.brickken.com/api-reference/postman.md): Download the official Brickken API Postman collection and environments
- [Tokenize an asset and run an STO](https://docs.brickken.com/api-reference/guides/tokenize-and-run-an-sto.md): The full Dapp API lifecycle, from creating a token to distributing dividends.
- [Browser wallets](https://docs.brickken.com/api-reference/guides/browser-wallets.md): Send a prepared transaction from MetaMask or another injected wallet without breaking on its parameter validator.
- [Troubleshooting](https://docs.brickken.com/api-reference/guides/troubleshooting.md): Decode a failed Dapp API call, from HTTP validation errors to raw on-chain revert data.
- [Prepare Transactions](https://docs.brickken.com/api-reference/endpoint/create.md): **Description:** This endpoint prepares unsigned transactions for the method selected in the `method` field. For the exact required and optional body fields of a single method, open the matching page under Prepare Transactions.
- [newTokenization](https://docs.brickken.com/api-reference/endpoint/prepare-newTokenization.md): Prepares the unsigned transactions that deploy a new tokenized asset.
- [mintToken](https://docs.brickken.com/api-reference/endpoint/prepare-mintToken.md): Issue tokens directly to investors, optionally whitelisting them in the same call.
- [whitelist](https://docs.brickken.com/api-reference/endpoint/prepare-whitelist.md): Authorize a wallet to hold a token, creating the investor record if it does not exist.
- [burnToken](https://docs.brickken.com/api-reference/endpoint/prepare-burnToken.md): Burn tokens held by the signing wallet.
- [transferFrom](https://docs.brickken.com/api-reference/endpoint/prepare-transferFrom.md): Prepares the unsigned transaction that transfers tokens from an address that approved the signer.
- [transferTo](https://docs.brickken.com/api-reference/endpoint/prepare-transferTo.md): Prepares the unsigned transaction that transfers tokens from the signer balance to another address.
- [approve](https://docs.brickken.com/api-reference/endpoint/prepare-approve.md): Grant an ERC-20 allowance before an investment or a dividend distribution.
- [dividendDistribution](https://docs.brickken.com/api-reference/endpoint/prepare-dividendDistribution.md): Distribute payment-token dividends to the holders of a tokenized asset.
- [newSto](https://docs.brickken.com/api-reference/endpoint/prepare-newSto.md): Launch a Security Token Offering for an existing tokenized asset.
- [newInvest](https://docs.brickken.com/api-reference/endpoint/prepare-newInvest.md): Invest in an open Security Token Offering on behalf of a registered investor.
- [claimTokens](https://docs.brickken.com/api-reference/endpoint/prepare-claimTokens.md): Collect tokens from a successful offering, or a refund from a rolled-back one.
- [closeOffer](https://docs.brickken.com/api-reference/endpoint/prepare-closeOffer.md): Finalize an offering after its end date, releasing the raise or entering rollback.
- [Send Transactions](https://docs.brickken.com/api-reference/endpoint/send.md): **Description:** This endpoint submits signed transactions to the blockchain. This endpoint works uniformly for all transaction types prepared using the `/prepare-transactions` endpoint.
- [Get Network Information](https://docs.brickken.com/api-reference/endpoint/get-network-info.md): **Description:** Retrieves network information for a specified chain ID.
- [Get Tokenizer Information](https://docs.brickken.com/api-reference/endpoint/get-tokenizer-info.md): **Description:** Reads the tokenizer and contract addresses of a specific token. This is the endpoint that returns the deployed token contract address (`tokenAddress`) after a `newTokenization` succeeds.
- [Get Token Information](https://docs.brickken.com/api-reference/endpoint/get-token-info.md): **Description:** Reads token information. The endpoint has two modes.
- [Get STOs](https://docs.brickken.com/api-reference/endpoint/get-stos.md): **Description:** Lists every offering of a tokenized asset. The response is a JSON array, not an object.
- [Get STO by ID](https://docs.brickken.com/api-reference/endpoint/get-sto-by-id.md): Read one Security Token Offering by its identifier.
- [Get STO Balance](https://docs.brickken.com/api-reference/endpoint/get-sto-balance.md): **Description:** This endpoint retrieves balance details and current status for a Security Token Offering (STO).
- [Get Investments by STO](https://docs.brickken.com/api-reference/endpoint/get-investments-by-sto.md): **Description:** This endpoint retrieves a list of investment transactions associated with a specific Security Token Offering (STO), identified by its UUID.
- [Get Investor Information](https://docs.brickken.com/api-reference/endpoint/get-investors-info.md): Returns detailed information about an individual investor, including personal details, KYC verification link, wallet address, investor type, and a list of all past investments. Each investment entry includes transaction details such as amount, currency, status, associated token, and offering metadat…
- [Get Whitelist Status](https://docs.brickken.com/api-reference/endpoint/get-whitelist-status.md): **Description:** Reads the whitelist flag of an address directly from the token contract.
- [Get Balance and Whitelist Status](https://docs.brickken.com/api-reference/endpoint/get-balance-whitelist.md): **Description:** Reads the on-chain token balance and whitelist flag of the wallet associated with an investor or owner email.
- [Get Allowance](https://docs.brickken.com/api-reference/endpoint/get-allowance.md): **Description:** Reads the payment-token allowance between two addresses for a tokenized asset. The value is returned as a decimal string in whole units, not in the smallest unit.
- [Get Dividend Distribution Info](https://docs.brickken.com/api-reference/endpoint/get-dividend-distribution.md): **Description:** Retrieves information about dividend distributions for a token.
- [Get Transaction Status](https://docs.brickken.com/api-reference/endpoint/get-transaction-status.md): **Description:** This endpoint retrieves the status of a transaction submitted through `/send-transactions`.
- [Update Token Documentation](https://docs.brickken.com/api-reference/endpoint/update-docs.md): **Description:** This endpoint allows you to update token-related documentation and branding materials. It is fully off-chain and does not prepare or require a blockchain transaction.
- [Create KYC Link](https://docs.brickken.com/api-reference/endpoint/create-kyc-link.md): Create or reuse an investor and return a Sumsub verification link.
- [Agentic API](https://docs.brickken.com/api-reference/endpoint/agentic-methods-x402.md): x402-paid Agentic API for ERC-8004 workflows on Base and ERC-8226 RAMS mandates on Ethereum Sepolia.
- [Pricing](https://docs.brickken.com/api-reference/endpoint/agentic-pricing.md): x402 pricing for Agentic API prepare and send operations.
- [Register Agent](https://docs.brickken.com/api-reference/endpoint/x402-agent-register.md): Prepare an ERC-8004 agent registration through x402.
- [Set Agent URI](https://docs.brickken.com/api-reference/endpoint/x402-agent-set-uri.md): Prepare an ERC-8004 agent URI/profile update through x402.
- [Set Agent Metadata](https://docs.brickken.com/api-reference/endpoint/x402-agent-set-metadata.md): Prepare an ERC-8004 agent metadata update through x402.
- [Set Agent Wallet](https://docs.brickken.com/api-reference/endpoint/x402-agent-set-wallet.md): Prepare an ERC-8004 operational wallet update through x402.
- [Transfer Agent Ownership](https://docs.brickken.com/api-reference/endpoint/x402-agent-transfer-ownership.md): Prepare an ERC-8004 identity ownership transfer through x402.
- [List Agents](https://docs.brickken.com/api-reference/endpoint/get-agents.md): List API-key-scoped agents or x402 owner-scoped agents.
- [Get Agent Information](https://docs.brickken.com/api-reference/endpoint/get-agent-info.md): Get a complete ERC-8004 agent profile by stored UUID or on-chain ID.
- [Get Agent Transactions](https://docs.brickken.com/api-reference/endpoint/get-agent-transactions.md): List ERC-8004, agent-token, and RAMS transactions for one agent.
- [Give Feedback](https://docs.brickken.com/api-reference/endpoint/x402-agent-feedback-give.md): Prepare ERC-8004 reputation feedback through x402.
- [Revoke Feedback](https://docs.brickken.com/api-reference/endpoint/x402-agent-feedback-revoke.md): Prepare ERC-8004 feedback revocation through x402.
- [Respond to Feedback](https://docs.brickken.com/api-reference/endpoint/x402-agent-feedback-respond.md): Prepare an ERC-8004 feedback response through x402.
- [Create Agent Token](https://docs.brickken.com/api-reference/endpoint/x402-token-create.md): Prepare an agent-owned ERC-20 token deployment through x402.
- [Mint Agent Token](https://docs.brickken.com/api-reference/endpoint/x402-token-mint.md): Prepare an agent-owned ERC-20 mint through x402.
- [Burn Agent Token](https://docs.brickken.com/api-reference/endpoint/x402-token-burn.md): Prepare an agent-owned ERC-20 burn through x402.
- [Transfer Agent Token](https://docs.brickken.com/api-reference/endpoint/x402-token-transfer.md): Prepare an agent-owned ERC-20 transfer through x402.
- [Transfer From Agent Token](https://docs.brickken.com/api-reference/endpoint/x402-token-transfer-from.md): Prepare an agent-owned ERC-20 allowance transfer through x402.
- [Approve Agent Token](https://docs.brickken.com/api-reference/endpoint/x402-token-approve.md): Prepare an agent-owned ERC-20 allowance approval through x402.
- [RAMS Mandates (ERC-8226)](https://docs.brickken.com/api-reference/endpoint/rams-overview.md): Compliance-gated, value-capped on-chain mandates that let principals delegate execution authority to AI agents.
- [Grant RAMS Mandate](https://docs.brickken.com/api-reference/endpoint/x402-rams-grant-mandate.md): Prepare a compliance-gated ERC-8226 mandate, directly or with a principal EIP-712 signature.
- [Revoke RAMS Mandate](https://docs.brickken.com/api-reference/endpoint/x402-rams-revoke-mandate.md): Prepare revocation of an ERC-8226 mandate.
- [Extend RAMS Mandate](https://docs.brickken.com/api-reference/endpoint/x402-rams-extend-mandate.md): Prepare a later expiry for an active ERC-8226 mandate.
- [Set RAMS Operator](https://docs.brickken.com/api-reference/endpoint/x402-rams-set-operator.md): Approve or remove an operator for an ERC-8226 principal.
- [Execute RAMS Action](https://docs.brickken.com/api-reference/endpoint/x402-rams-execute.md): Prepare an agent action through the principal-bound AgentExecutor.
- [Set RAMS Executor Action](https://docs.brickken.com/api-reference/endpoint/x402-rams-set-executor-action.md): Register or update the ActionSpec for a function selector on an AgentExecutor.
- [Freeze RAMS Agent](https://docs.brickken.com/api-reference/endpoint/x402-rams-freeze-agent.md): Prepare an enforcement freeze for an ERC-8226 agent.
- [Unfreeze RAMS Agent](https://docs.brickken.com/api-reference/endpoint/x402-rams-unfreeze-agent.md): Prepare removal of an enforcement freeze from an ERC-8226 agent.
- [Grant RAMS Principal Eligibility](https://docs.brickken.com/api-reference/endpoint/x402-rams-grant-principal.md): Prepare a compliance eligibility record for a principal.
- [Revoke RAMS Principal Eligibility](https://docs.brickken.com/api-reference/endpoint/x402-rams-revoke-principal.md): Prepare revocation of a principal compliance record.
- [Get RAMS Mandate](https://docs.brickken.com/api-reference/endpoint/rams-get-mandate.md): Read an ERC-8226 mandate and its derived lifecycle status.
- [Check RAMS Execution](https://docs.brickken.com/api-reference/endpoint/rams-can-execute.md): Check whether a mandate currently permits an action and value.
- [Get RAMS Status](https://docs.brickken.com/api-reference/endpoint/rams-status.md): Read agent freeze state, principal nonce, and operator approval.
- [Check RAMS Compliance](https://docs.brickken.com/api-reference/endpoint/rams-compliance-status.md): Read a principal eligibility record from a ComplianceProvider.
- [Get RAMS Executor Action](https://docs.brickken.com/api-reference/endpoint/rams-executor-action.md): Return the ActionSpec for a function selector from an AgentExecutor.
- [RAMS EIP-712 Typed Data](https://docs.brickken.com/api-reference/endpoint/rams-typed-data.md): Fetch complete typed-data envelopes for signature-authorized RAMS lifecycle operations.
- [MCP](https://docs.brickken.com/mcp/introduction.md): Hosted Brickken MCP server for API-key and x402 workflows in MCP-compatible AI agents.
- [Base MCP](https://docs.brickken.com/mcp/base-mcp.md): Drive the Brickken Agentic API from an agent using a Base Account wallet, with Brickken carrying the signing and the gas.
- [CLI](https://docs.brickken.com/cli/introduction.md): Public Brickken CLI for the Dapp API, KYC, the Sandbox/Forge BKN faucet, agent getters, x402-paid writes, and ERC-8226 RAMS mandates.
- [Installation](https://docs.brickken.com/cli/installation.md): Install the Brickken CLI from npm and verify your setup.
- [Quickstart](https://docs.brickken.com/cli/quickstart.md): Set up your environment and run your first end-to-end Brickken CLI transaction.
- [Authentication & Configuration](https://docs.brickken.com/cli/authentication.md): Dapp API, KYC, faucet, API-key-or-x402 reads, private-key signing, environments, and CLI configuration.
- [kyc](https://docs.brickken.com/cli/commands/kyc.md): Create API-key-authenticated investor KYC links from the Brickken CLI.
- [BKN Faucet](https://docs.brickken.com/cli/commands/faucet.md): Request 100 BKN on Ethereum Sepolia with an API key or x402.
- [dapp](https://docs.brickken.com/cli/commands/dapp.md): Call API-key-authenticated Dapp API read and JSON endpoints from the terminal.
- [agent](https://docs.brickken.com/cli/commands/agent.md): Manage ERC-8004 agent identity and reputation from the Brickken CLI.
- [Token economics](https://docs.brickken.com/cli/commands/token-economics.md): Create, mint, burn, transfer, and approve agentic ERC-20 tokens with the Brickken CLI.
- [rams](https://docs.brickken.com/cli/commands/rams.md): Manage ERC-8226 mandates, compliance, executor actions, reads, and EIP-712 signatures from the Brickken CLI.
- [tx](https://docs.brickken.com/cli/commands/tx.md): API-key or x402 prepare, sign, send, and status flows for Brickken Dapp and Agentic API methods.
- [Agent & Token Workflow](https://docs.brickken.com/cli/guides/agent-and-token-workflow.md): An end-to-end walkthrough: register an ERC-8004 agent, then deploy and manage its token with the Brickken CLI.
- [RAMS Mandate Workflow](https://docs.brickken.com/cli/guides/rams-mandate-workflow.md): End-to-end Ethereum Sepolia setup and execution for a compliant principal and AI-agent wallet.
- [SDK](https://docs.brickken.com/sdk/introduction.md): Typed TypeScript client for the Dapp API, the Agentic API, and RAMS mandates.
- [Installation](https://docs.brickken.com/sdk/installation.md): Install brickken-sdk, and pick the signer adapter that matches your stack.
- [Quickstart](https://docs.brickken.com/sdk/quickstart.md): A first Dapp read and a first agentic write with the SDK, on sandbox.
- [Authentication](https://docs.brickken.com/sdk/authentication.md): API key or x402 signer — which credential the SDK uses, and which combinations it refuses.
- [Execution modes](https://docs.brickken.com/sdk/execution-modes.md): Who signs the transaction, who broadcasts it, and what each mode costs.
- [Payments](https://docs.brickken.com/sdk/payments.md): How the SDK handles the x402 handshake, and the three controls that bound what it can spend.
- [Signers](https://docs.brickken.com/sdk/signers.md): The Signer contract, the three bundled adapters, and how to bring your own KMS or MPC wallet.
- [Errors](https://docs.brickken.com/sdk/errors.md): Fourteen typed error classes, what each one means, and which ones carry recoverable state.
- [Namespaces](https://docs.brickken.com/sdk/namespaces.md): Every SDK method, mapped to the backend method or endpoint it reaches.
- [BKN Faucet](https://docs.brickken.com/sdk/faucet.md): Request test BKN with automatic UUID-v4 idempotency and API-key or x402 authentication.
- [Configuration](https://docs.brickken.com/sdk/configuration.md): Every constructor option, the environment table, and how to build a client from the environment.
- [Tokenize an asset and run an STO](https://docs.brickken.com/sdk/guides/tokenize-and-run-an-sto.md): The full Dapp API lifecycle with the SDK, from creating a token to distributing dividends.
- [Agent and token workflow](https://docs.brickken.com/sdk/guides/agent-and-token-workflow.md): Register an ERC-8004 agent with the SDK, then deploy and operate its own ERC-20.
- [RAMS mandate workflow](https://docs.brickken.com/sdk/guides/rams-mandate-workflow.md): Grant, use, and revoke an ERC-8226 mandate with the SDK, including the signature-authorized path.
- [Skill](https://docs.brickken.com/skill/introduction.md): Brickken AI-agent skill for the Dapp API, Agentic API, CLI, and MCP.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)
- [approve](/api-reference/prepare/approve.json)
- [burnToken](/api-reference/prepare/burnToken.json)
- [claimTokens](/api-reference/prepare/claimTokens.json)
- [closeOffer](/api-reference/prepare/closeOffer.json)
- [dividendDistribution](/api-reference/prepare/dividendDistribution.json)
- [mintToken](/api-reference/prepare/mintToken.json)
- [newInvest](/api-reference/prepare/newInvest.json)
- [newSto](/api-reference/prepare/newSto.json)
- [newTokenization](/api-reference/prepare/newTokenization.json)
- [transferFrom](/api-reference/prepare/transferFrom.json)
- [transferTo](/api-reference/prepare/transferTo.json)
- [whitelist](/api-reference/prepare/whitelist.json)