Biometry CLI

The Biometry CLI is a command-line tool for developers and AI agents to interact with the Biometry platform. It supports authentication, transaction queries, and consent management.

Download

Download the latest binary for your platform:

Platform	Architecture	Download
macOS	Apple Silicon (M1/M2/M3)	biometry-cli-darwin-arm64
macOS	Intel	biometry-cli-darwin-amd64
Linux	x86_64	biometry-cli-linux-amd64
Linux	ARM64	biometry-cli-linux-arm64
Windows	x86_64	biometry-cli-windows-amd64.exe

Installation

macOS / Linux

# Download (example for macOS Apple Silicon)
curl -L -o biometry-cli https://storage.googleapis.com/biometry-cli-releases/releases/latest/biometry-cli-darwin-arm64

# Make it executable
chmod +x biometry-cli

# Move to your PATH
sudo mv biometry-cli /usr/local/bin/

Windows

Download the .exe file from the table above and add it to your system PATH.

Verify installation

biometry-cli --version

Authentication

Before using the CLI, log in with your Biometry account:

biometry-cli auth login --email [email protected] --password yourpassword

If MFA is enabled on your account, you will be prompted to complete verification:

biometry-cli auth mfa-verify --mfa-token <token> --code <code>

Other auth commands

# Check login status
biometry-cli auth status

# View your profile
biometry-cli auth me

# Refresh your access token
biometry-cli auth refresh

# Logout
biometry-cli auth logout

Transactions

Query and search transactions. You can use transactions or the shorthand tx.

# List transactions for a project
biometry-cli tx list --project-id <id>

# Get a specific transaction
biometry-cli tx get <transaction-id>

# Search with filters
biometry-cli tx search --project-id <id> --status completed --decision pass

# Count transactions
biometry-cli tx count --project-id <id> --from 2025-01-01 --to 2025-12-31

# List sessions
biometry-cli tx sessions --project-id <id>

Fraud Detection

Investigate and manage fraud events. You can use fraud or the shorthand fd.

# List fraud events for a project
biometry-cli fraud list --project-id <id>

# Filter by rule and severity
biometry-cli fraud list --project-id <id> --rule impossible_travel --severity high

# Filter by user and date range
biometry-cli fraud list --project-id <id> --user [email protected] --from 2026-03-01 --to 2026-03-31

# Get a specific fraud event with linked transaction details
biometry-cli fraud get <event-id>

# Get a user's risk profile (events, locations, devices)
biometry-cli fraud profile --project-id <id> --user [email protected]

# Review a fraud event
biometry-cli fraud review <event-id> --action confirm_fraud
biometry-cli fraud review <event-id> --action dismiss
biometry-cli fraud review <event-id> --action escalate

# Get fraud statistics
biometry-cli fraud stats --project-id <id>
biometry-cli fraud stats --project-id <id> --from 2026-03-01 --to 2026-03-31

Available rules: impossible_travel, device_switching, emulator_detection, ip_geo_anomaly, rapid_fire, new_device_new_location.

Manage user consent records:

# Check consent status
biometry-cli consent check --project-id <id> --user-id <user-id>

# List all consents
biometry-cli consent list --project-id <id>

# Check storage consent
biometry-cli consent storage check --project-id <id> --user-id <user-id>

# List storage consents
biometry-cli consent storage list --project-id <id>

Output Formats

The CLI supports JSON (default) and table output:

# JSON output (default)
biometry-cli tx list --project-id <id>

# Table output
biometry-cli tx list --project-id <id> --format table

Configuration

The CLI stores its configuration and tokens in ~/.biometry-cli/:

config.json — API endpoint configuration
tokens.json — Authentication tokens (stored with restricted permissions)

Custom API endpoints

You can override default API endpoints using environment variables:

export BIOMETRY_AUTH_URL=https://your-custom-auth-url
export BIOMETRY_TRANSACTIONS_URL=https://your-custom-transactions-url
export BIOMETRY_CONSENT_URL=https://your-custom-consent-url