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.

The Truthlocks consumer portal at verify.truthlocks.com allows end-users to protect content, view and manage verified credentials, and share proofs of authorship. It provides a dashboard with at-a-glance metrics, a secure inbox for receiving credentials from issuers, and self-service settings for API keys, billing, and security.

​
Dark mode

The verify portal supports full dark mode across all consumer pages. You can switch between three appearance modes:
ModeBehavior
LightLight backgrounds with dark text
DarkDark backgrounds with light text, optimized for low-light environments
SystemAutomatically matches your operating system’s appearance preference
To change the theme, click the appearance toggle in the top bar. The icon cycles through sun (light), moon (dark), and monitor (system) on each click. Your preference is saved locally and persists across sessions.
Dark mode applies to every consumer page — Dashboard, Protections, Inbox, History, Saved, Profile, Privacy, Security, Billing, and all Settings screens.
The verify portal uses a collapsible navigation rail on the left side of the screen:
  • Collapsed state — a narrow 64 px 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 keep it expanded.
  • Mobile — on small screens, navigation is accessible through a hamburger menu that opens a slide-out drawer.
The rail includes quick links to your dashboard, protections, inbox, portfolio, verify page, and settings. Your profile avatar and the theme toggle appear at the bottom of the rail.

​
Dashboard

The dashboard is your home screen after signing in. It shows five stat cards summarizing your activity:
MetricDescription
ProtectedTotal items you have protected
VerificationsNumber of times others have verified your content
Portfolio viewsPage views on your public portfolio
PublicProtections currently visible in your portfolio
InboxUnread inbox items
Below the stats you see your most recent protections and latest inbox activity.

​
Quick Protect

The dashboard includes a drag-and-drop zone for one-click protection. Drop any file onto the zone and Truthlocks automatically hashes it, runs AI metadata extraction, and mints a private protection — no manual title or description entry required. After the protection is created you are redirected to your protections list.
Quick Protect always creates private protections. To make a protection public and add it to your portfolio, toggle its visibility from the Protections page.

​
New user onboarding

If you have not protected anything yet, the dashboard shows a guided setup:
1

Set up your profile

Add your display name and public username from the Profile page.
2

Protect your first work

Upload or paste content to timestamp it on the Protect page.
3

Build your portfolio

Make protections public to showcase your verified work.

​
Signing identity setup

The first time you protect content, Truthlocks creates a personal signing identity (issuer) for your account. This is a one-time step that happens automatically — you see a brief setup prompt, then the protection proceeds normally.

​
Protections

The Protections page displays all content you have protected. You can switch between a grid view (visual cards) and a list view (compact table). Each protection shows:
  • Title and description — auto-generated by AI or manually entered.
  • Category — indicated by a color-coded icon (photography, digital art, source code, document, music, video, design, data, or other).
  • File details — original file name, size, and content type.
  • Content hash — the SHA-256 fingerprint of your file.
  • Visibility — whether the protection is public (shown in your portfolio) or private.
  • Verification count — how many times third parties have verified this protection.
  • Date — when the protection was created.
To change a protection’s visibility, click the protection to view its details and toggle between public and private. Public protections appear on your portfolio page.

​
Inbox

The inbox is where you receive new credentials. When an issuer (like a bank or employer) issues a credential to your email, it appears here.
  • Unread: New items appear with a blue badge.
  • Details: Click an item to view the claims and cryptographic proof details.
  • Archive: Move items to history once you have reviewed them.

​
History

The history page stores all your past credentials. You can browse, filter, and archive items you have already reviewed. Three filter tabs help you find what you need:
FilterShows
AllAll credentials except unread items (those stay in your inbox)
ReadCredentials you have opened and viewed
ArchivedCredentials you have archived from the inbox
Click any item to open a detail panel with the issuer name, creation date, delivery state, and the credential’s metadata. To archive a credential, click the archive button from the detail view.

​
Saved credentials

Bookmark credentials from verifications for quick access later. Each saved item stores a title, optional notes, optional tags, and the verification data.
1

Save a credential

When viewing a verification result, click Save to bookmark it. Add an optional title, notes, and tags to help you find it later.
2

Browse saved items

Open the Saved page from the sidebar to see all bookmarks. Each entry shows its title, tags, and the date you saved it.
3

Remove when no longer needed

Click the remove button on any saved item to delete it permanently.

​
API keys

You can create personal API keys to access Truthlocks endpoints programmatically — for example, to mint attestations from a CI pipeline or integrate content protection into your own tools.

​
Limits and expiry

  • Each consumer can hold up to 5 active keys at a time.
  • Keys automatically expire 90 days after creation.
  • Revoked or expired keys cannot be reactivated. Create a new key instead.

​
Creating a key

1

Open settings

In the consumer portal sidebar, go to Settings > API Keys.
2

Create a key

Click Create API Key, enter a descriptive name, and confirm. The full secret is displayed once — copy and store it securely.
3

Use the key

Pass the key in the X-API-Key header with every request.

​
Example request

curl -X GET https://api.truthlocks.com/v1/consumer/protections \
  -H "X-API-Key: tlk_your_key_here"
You can also pass the key using the Authorization header: 
curl -X GET https://api.truthlocks.com/v1/consumer/protections \
  -H "Authorization: ApiKey tlk_your_key_here"
Both formats work on all endpoints. See authentication for details.

​
Revoking a key

Open Settings > API Keys, find the key you want to remove, and click Revoke. Revocation is immediate and permanent — any in-flight requests using that key will start returning 401.

​
Default scopes

Every consumer API key is issued with these scopes:
ScopeDescription
consumer:readRead your consumer profile and settings
consumer:writeUpdate your consumer profile and settings
attestations:mintMint new attestations
attestations:readRead your attestations
verify:readVerify attestations

​
Security best practices

The full key secret is shown only once at creation time. If you lose it, revoke the key and create a new one.
  • Store keys in a secrets manager or environment variable — never hard-code them.
  • Rotate keys before they expire to avoid service interruptions.
  • Revoke keys you no longer need.

​
Plans and billing

Three plans are available for individual users on the verify portal:
PlanPriceProtections per monthKey features
Free$050SHA-256 hashing, transparency log, shareable proof links, public portfolio
Creator$9/mo500Everything in Free plus AI metadata extraction, custom verification badges, priority verification, and content monitoring alerts
Pro$29/moUnlimitedEverything in Creator plus API access, bulk protection, advanced analytics, priority support, and custom portfolio domain
To view your current plan and usage, go to Settings > Billing in the verify portal. The page shows your plan name, status, renewal date, and three usage meters:
  • Protections this month — count of protections minted in the current billing cycle, shown against your plan limit.
  • Storage used — total storage consumed by your protection records.
  • API calls — number of API requests made in the current period.

​
Upgrading

Free users see an upgrade prompt linking to the pricing page. Select Creator or Pro, then complete checkout. Payment is processed through Stripe, Paystack, or Flutterwave depending on your region — see provider routing for details.

​
Managing payment methods

Paid subscribers can update their payment method from Settings > Billing. Clicking Update Payment Method redirects you to a secure portal hosted by your payment provider.

​
Canceling

Paid subscribers can cancel from Settings > Billing. Your plan remains active until the end of the current billing period, then downgrades to Free.

​
Settings

Portal settings are organized into three groups: Account, Preferences, and Data.

​
Account

PageDescription
Billing & subscriptionView your current plan (Free, Creator, or Pro), usage meters for protections, storage, and API calls, renewal date, and upgrade options.
SecurityManage your password, enable MFA, and review login activity. See account security.
API keysCreate, view, and revoke personal API keys (5-key limit, 90-day expiry).
Connected appsView and revoke third-party applications that have OAuth access to your account. Each entry shows the app name, grant date, and permission count. To revoke access, click the app and confirm in the dialog.

​
Preferences

PageDescription
AppearanceSwitch between light, dark, and system themes. See dark mode.
NotificationsToggle verification alerts, security alerts, marketing emails, and push notifications.
Language & regionChoose your display language (English, Spanish, French, German, Chinese) and data residency region (US, EU, Africa, UK, Canada, Australia, Singapore).
DevicesView linked mobile devices used for biometric authentication, including device name, type, verification status, and last active date.
Changing your data residency region triggers a data migration. Choose your region carefully — this affects where your data is stored and processed.

​
Data

PageDescription
Export your dataRequest a full export of your credentials, profile, and activity logs. Downloads are available once processing completes. See privacy center.
Delete accountPermanently delete your account and all associated data. Requires email confirmation.

Content protection

Protect content with cryptographic attestations.

Account security

MFA, password management, and session controls.

Public portfolio

Showcase verified work on a public profile page.

AI metadata

How AI categorizes and describes your content.

​
For developers

List API keys

GET /v1/consumer/api-keys

Create API key

POST /v1/consumer/api-keys

Revoke API key

POST /v1/consumer/api-keys/{id}/revoke

Consumer inbox

GET /v1/consumer/inbox