Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

When you first sign in to console.truthlocks.com, a guided wizard walks you through everything you need to start issuing attestations. The wizard detects your progress automatically — if you leave and come back, it picks up where you left off.

​
Prerequisites

  • A Truthlocks account. Sign up if you do not have one yet.

​
Onboarding steps

1

Tenant profile

Enter your organization’s basic information:
  • Name — your organization’s display name.
  • Slug — a URL-friendly identifier used in API paths and your console URL.
  • Contact email — the primary email for platform communications.
  • Country — where your organization is based (used for data residency).
This information is saved to your tenant record and can be updated later from Settings > Organization.
2

Organization

Create or select an organization within your tenant. Organizations let you group issuers, users, and attestations under a single entity. Enter:
  • Organization name — the legal or operating name of the organization.
If your tenant already has an organization, this step is skipped automatically.
3

Team invites

Invite team members by email and assign them a role:
RolePermissions
AdminFull access to all tenant resources, settings, and team management
MemberCreate and manage issuers, mint attestations, view audit logs
ViewerRead-only access to issuers, attestations, and audit logs
You can skip this step and invite team members later from the Team settings page.
4

Issuer profile

Create your first issuer — the entity that signs attestations on behalf of your organization:
  • Legal name — the issuer’s registered legal name.
  • Display name — the name shown on attestations and proof pages.
  • Website — the issuer’s public website URL.
  • Contact email — used for trust registry verification.
The issuer is created at assurance level L1 (basic). You can request a higher assurance level after onboarding by submitting compliance documentation.If your tenant already has an issuer configured, this step is skipped.
5

Signing keys

Generate an Ed25519 signing key for your issuer. This key is used to cryptographically sign every attestation your issuer creates.Click Generate keys and the wizard creates a key pair automatically. The public key is registered with the Truthlocks platform, while the private key is stored securely in the signing service.
Signing keys cannot be deleted once generated. If a key is compromised, use the key compromise endpoint to mark it as compromised and rotate to a new key.
If your issuer already has signing keys, this step shows the existing key details and lets you proceed.
6

Test mint

Verify your setup by minting a test attestation. The wizard provides a searchable list of attestation schemas organized into categories:
  • Identity — email verification, KYC, government ID
  • Employment — employment verification, background check, income
  • Education — degree, transcript, enrollment
  • Healthcare — license, immunization, insurance
  • Compliance — SOC2, ISO 27001, GDPR
  • Financial — accreditation, bank verification, credit
  • Skills — certification, assessment, portfolio
  • Supply chain — origin, quality, shipment
  • Other — custom claims
Select a schema, enter a recipient email address, and click Mint test attestation. The wizard calls the attestation mint endpoint and shows you the resulting attestation ID on success.
The test attestation is a real attestation recorded on the transparency log. You can verify it immediately using the verify endpoint.
7

Go live

The final step shows a checklist of prerequisites:
  • Tenant profile completed
  • Organization created
  • Issuer profile configured
  • Pipeline verified (test attestation minted)
When all items are checked, click Activate & go to console to complete onboarding and access the full console dashboard.

​
After onboarding

Once the wizard is complete, you land on the tenant console dashboard.

​
Tenant dashboard

The dashboard displays four stat cards at the top:
CardWhat it shows
Active issuersTrusted issuers out of total configured
AttestationsTotal attestations with active or revoked count
Active attestationsCurrently valid attestations
Roles configuredSystem and custom roles
When you have at least one attestation, three insight charts appear below the stat cards:
  • Attestation status — a donut chart breaking down active, revoked, and other attestations.
  • Issuer coverage — a bar chart comparing active issuers versus total issuers.
  • Platform health — a radial gauge showing the percentage of attestations that are currently active.
If your organization has a pending compliance request, a banner appears at the top of the dashboard with the requirements and deadline. Click Review & Submit to go to the compliance settings page. A Quick Actions section provides shortcuts to manage issuers, view attestations, and manage API keys. From the dashboard you can also:
  • Mint attestations at scale via the console UI or API.
  • Configure webhooks to receive real-time event notifications.
  • Set up governance policies for multi-party approval workflows.
  • Manage API keys for programmatic access.

​
Dark mode

The console supports dark mode across all pages. You can switch between three appearance modes from the top bar:
ModeBehavior
LightLight backgrounds with dark text
DarkDark backgrounds with light text, optimized for low-light environments
SystemAutomatically matches your operating system’s appearance preference
Click the theme toggle icon in the top bar to cycle through the modes — sun (light), moon (dark), and monitor (system). You can also switch themes from the profile menu — click your avatar in the top-right corner to open a dropdown with light, dark, and system buttons. Your preference is saved locally and persists across sessions.
The console defaults to dark mode on first load. The verify portal has its own independent theme setting — see the consumer portal guide.

​
Console navigation

The console uses a collapsible navigation rail on the left side of the screen:
  • Collapsed state — a narrow rail showing only icons. Hover over it to expand and reveal labels.
  • Expanded state — the full sidebar with icons and page names. Click the pin icon to lock it open.
  • Mobile — on smaller screens, navigation is accessible through a hamburger menu that opens a slide-out drawer.
The rail organizes pages into groups — your dashboard, issuers, attestations, verification, API keys, audit logs, and settings. The active page is highlighted, and each group collapses independently. The top bar displays breadcrumbs for your current location, a search shortcut, the environment switcher, the theme toggle, and a profile menu.

​
Search palette

Press Cmd+K (macOS) or Ctrl+K (Windows/Linux) to open the search palette, or click the search bar in the top bar. The palette lets you jump to any page in the console without navigating through menus. Results include every page available to your role — dashboard, issuers, attestations, verification packs, audit logs, settings, and more. Start typing to filter the list, then press Enter to navigate to the selected page.
The search shortcut works from anywhere in the console. It is the fastest way to switch between pages when you already know where you want to go.

​
Profile menu

Click your avatar in the top-right corner to open the profile menu. The avatar displays the first letter of your organization name against a gradient background. The dropdown is organized into three sections:
  • Account info — your organization name and email address.
  • Account settings — opens the security settings page where you can manage your password, sessions, and MFA preferences.
  • Theme switcher — three inline buttons for light, dark, and system themes. The active theme is highlighted. This is an alternative to the theme toggle icon in the top bar.
  • Sign out — logs you out of the console. A confirmation dialog appears before the session ends to prevent accidental sign-outs.

​
Announcements

The Announcements page displays platform-wide messages from Truthlocks — including system updates, security alerts, and operational notifications. Access it from the sidebar under Announcements. Each announcement has a priority level:
PriorityWhen it is used
NormalGeneral platform updates and informational messages
UrgentTime-sensitive changes that may affect your workflows
CriticalSecurity alerts or service disruptions that require immediate attention
The announcements page uses a master-detail layout:
  • Left panel — a searchable, filterable list of all announcements. Filter by All, Unread, or Important (urgent and critical only). Unread messages show a blue dot indicator.
  • Right panel — the full content of the selected announcement, including the priority badge, timestamp, and sender details.
Click an announcement to view it and automatically mark it as read. Use the Mark all read button to dismiss all unread indicators at once.

Quick start

Issue your first attestation via the API in under 5 minutes.

Core concepts

Understand tenants, issuers, attestations, and verification.

Environments

Sandbox vs. production environment configuration.

RBAC

Role-based access control and permission management.