> ## Documentation Index > Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Dashboard Guide > A complete guide to the KeyStone dashboard - managing settlements, team members, and platform settings. The KeyStone dashboard is your central hub for managing settlements, compliance, and platform settings. This guide walks you through every feature available. ## Getting Started ### First-Time Setup When your platform is first created, a designated admin completes a short onboarding wizard: A quick introduction to KeyStone and what to expect. Upload your company logo (or skip). This appears in your dashboard header. Add team members by email and assign roles. You can invite multiple people at once, or skip and do it later. You are all set. The wizard redirects you to the Getting Started page. Only users with the **Platform Manager** role can complete onboarding. Other team members will see a "Setup in progress" screen until onboarding is finished. ### Getting Started Page After onboarding, the **Getting Started** page acts as your setup checklist with milestones: View the available settlement templates pre-configured by KeyStone. Run your first settlement through the API. Bring your colleagues on board. A progress indicator at the top shows how many steps you have completed. *** ## Dashboard Overview The main dashboard gives you a snapshot of your settlement activity at a glance: | Metric | Description | | ------------------------- | --------------------------------------------------------- | | **Total Settlements** | Total settlements your platform has initiated | | **Active Settlements** | Settlements currently in progress | | **Completed Settlements** | Successfully finalized settlements | | **Compliance Pending** | Settlements awaiting a compliance decision from your team | Below the stats, a **Recent Settlements** table shows your last 10 settlements with their current state. Click any row to jump to the full detail view. *** ## Settlements ### Settlement List Navigate to **Settlements** in the sidebar to see all your settlements. The list view provides: * **Tabs** to quickly filter by status: All, Active, Compliance, Settled, Failed * **Sortable columns**: Reference ID, State, Asset, Quantity, Amount, Parties, Created date * **Pagination** for large datasets (20 settlements per page) Click any row to open the settlement detail view. ### Settlement Detail The detail view gives you complete visibility into a single settlement: * **Overview Card** - Settlement ID, idempotency key, template, external reference, timeout, and timestamps. * **State Badge** - The current settlement state, color-coded for quick recognition. * **Parties Card** - All parties involved, their roles, and their current status. * **Financials Card** - Payment details including amount and currency. * **Event Timeline** - A chronological log of every state transition with sequence numbers, triggers, timestamps, and expandable payloads. ### Compliance Decisions When a settlement reaches the **Compliance Checking** state, your team needs to make a decision. If you have the appropriate permissions, a **Compliance Decision** card appears with two options: * **Approve** - Clears the compliance check and allows the settlement to proceed. * **Reject** - Rolls back the settlement entirely. Both actions require a confirmation dialog. Rejecting a settlement is irreversible - it will be rolled back immediately. *** ## Templates Settlement templates define the rules, states, and actions that govern how a settlement flows from initiation to finalization. ### Template List The **Templates** page shows all templates available to your platform with their name, status, type, and creation date. ### Template Detail Click a template to see its full configuration (read-only): * **Template Info** - Name, type, and version number. * **State Machine** - A visual representation of all possible states and transitions. * **Compliance Requirements** - Which compliance providers are configured. * **Required Roles** - What party roles are needed. Templates are managed by KeyStone. If you need changes to a template, contact your KeyStone representative. *** ## Activity Log The **Activity Log** (via **Logs** in the sidebar) provides an audit trail of important actions: * Who performed the action (user name/email) * What action was taken * Which resource was affected * When it happened This is useful for compliance audits, debugging, and understanding what happened during a settlement. *** ## Team Management ### Viewing Members Navigate to **Members** in the sidebar. The page has two tabs: **Members Tab** * Shows all current team members with their avatar, name, email, and assigned roles. * Your own entry is marked with a **"You"** badge. * Use the action menu on any member to **Edit Roles** or **Remove** them. You cannot edit your own roles or remove yourself. **Invitations Tab** * Shows all pending invitations that have not been accepted yet. * Displays the invitee's email, assigned roles, who sent the invitation, and when. * Use the action menu to **Cancel** a pending invitation if needed. ### Inviting New Members Click the **Invite Member** button (top-right of the Members page). Enter the person's **email address** and optionally select one or more **roles**. Click **Send Invitation**. The invitee receives an email with a link to join your platform. You need the **Members Manager** permission to invite, edit, or remove team members. *** ## Settings Access platform settings via the **Settings** item in the sidebar. ### General **Platform Profile** (editable) * **Name** - Your platform's display name in KeyStone. * **Logo URL** - A URL pointing to your company logo. * **Support Email** - Where KeyStone can reach your support team. * **Support URL** - A link to your support portal or documentation. **Platform Info** (read-only) shows your Platform ID, status, and timestamps. ### Webhooks Webhooks let KeyStone notify your systems in real time when events happen (e.g., a settlement changes state). See the dedicated [Webhooks Guide](/guides/webhooks) for full details on setup and event types. ### Security **IP Allowlisting** restricts API access to specific IP addresses or ranges. * When the allowlist is **empty**, all IPs are permitted. * Once you add **at least one entry**, only listed IPs are allowed. Be careful when configuring IP allowlisting. Adding an incorrect range could lock out your own systems. Always ensure your current IP is included before enabling restrictions. *** ## Settlement State Reference | State | What is Happening | | ----------------------- | ------------------------------------------------------------------------------------ | | **Instructed** | Settlement has been created on-chain and is queued for processing. | | **Compliance Checking** | Compliance checks are running against parties and wallets. | | **Compliance Cleared** | All compliance checks passed. Compliance attested on-chain. | | **Awaiting Deposits** | Waiting for parties to deposit assets to escrow contracts. | | **Executing Swap** | All deposits confirmed. Contracts are auto-executing the atomic swap. | | **Finalized** | Settlement complete. Assets delivered to counterparties. | | **Rolled Back** | Settlement reversed. All locked assets returned to original owners. | | **Timed Out** | Settlement exceeded its deadline. Deposits reclaimable by their depositors on-chain. | *** ## Roles and Permissions | Permission | What It Allows | | ---------------------- | ----------------------------------------------------------- | | **View Settlements** | See settlement list and details | | **Manage Settlements** | Approve or reject compliance decisions | | **View Templates** | See settlement template configurations | | **Manage Platform** | Edit platform settings, configure webhooks, manage security | | **Manage Members** | Invite new members, edit roles, remove members | *** ## Best Practices Webhooks are the primary way to stay informed about settlement progress. Configure them before your first settlement. Restrict API access to known IPs in production to prevent unauthorized access. Regularly review the audit trail for compliance reporting and incident investigation. As a security best practice, rotate your HMAC signing secrets on a regular cadence.