Dashboard Guide

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:

​

Getting Started Page

After onboarding, the Getting Started page acts as your setup checklist with four milestones: A progress indicator at the top shows how many steps you’ve completed. The page also provides quick links to API documentation, webhook configuration, and support resources.

---

​

Dashboard Overview

The main dashboard gives you a snapshot of your settlement activity at a glance: 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.

---

​

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.
• Config Summary - Asset type, payment currency, and other defaults.
• Compliance Requirements - Which compliance providers are used and their risk thresholds.
• State Machine - A visual representation of all possible states and transitions.
• Actions - What happens at each stage of the settlement lifecycle.

---

​

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.

Invitations Tab

• Shows all pending invitations that haven’t 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

Once they accept, they’ll appear in the Members tab.

​

Editing Roles

1. Click the action menu (three dots) next to a team member.
2. Select Edit Roles.
3. Check or uncheck the available roles.
4. Click Save.

Role changes take effect immediately.

---

​

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.

Click Edit to modify these fields, then Save to apply changes. Platform Info (read-only) shows your Platform ID, status, and timestamps.

​

Settlement Defaults

Configure default behavior for new settlements initiated through your platform. These defaults can be overridden per-settlement via the API.

​

Webhooks

Webhooks let KeyStone notify your systems in real time when events happen (e.g., a settlement changes state, compliance check completes). See the dedicated Webhooks Guide for full details on setup and event types. Quick actions per endpoint:

• View Deliveries - See every delivery attempt with status codes, timing, and errors.
• Send Test Ping - Verify your endpoint is reachable.
• Rotate Secret - Generate a new HMAC signing secret.
• Delete Endpoint - Permanently remove (requires confirmation).

​

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.

To add an IP, enter a CIDR notation address (e.g., 203.0.113.0/24 for a range, or 203.0.113.42/32 for a single IP), optionally add a description, and click Add.

---

​

Settlement State Reference

Settlements move through a defined lifecycle. Here’s what each state means:

---

​

Roles and Permissions

KeyStone uses role-based access control: Your platform administrator assigns roles when inviting new members. Roles can be updated at any time from the Members page.

---

​

Best Practices