Proof CLI (unofficial)

Proof CLI

An unofficial command-line interface for interacting with the Proof API. The Proof CLI provides access to Business, Real Estate, and SCIM APIs through a unified interface.

This is an alpha product and should be treated as such. It is not an official product from Proof.

Installation

Prebuilt binary

# macOS / Linux: downloads the latest release for your OS and CPU into the current directory

curl -sL "https://github.com/tsarlewey/proof-cli/releases/latest/download/proof_$(uname -s | tr A-Z a-z)_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar xz proof ./proof version

Windows zips and checksums are on the Releases page.

Install via Go

go install github.com/tsarlewey/proof-cli@latest

From Source

git clone https://github.com/tsarlewey/proof-cli.git

cd proof-cli go build -o proof ./proof --help

Use with AI agents

Claude Code plugin (bundles a usage skill and the MCP server; needs proof on your PATH):

/plugin marketplace add tsarlewey/proof-cli

/plugin install proof@proof

MCP server for any MCP client. proof mcp exposes every API command as a tool over stdio, annotated read-only or destructive:

claude mcp add proof -- proof mcp               # Claude Code

claude mcp add proof -- proof mcp --read-only # only tools that don't change anything

For other clients, run the command proof mcp. It reads credentials the same way as the CLI (PROOF_API_KEY or proof config).

Docker, with nothing installed locally. The image runs proof mcp and is listed in the MCP Registry as io.github.tsarlewey/proof-cli:

docker run -i --rm -e PROOF_API_KEY -e PROOF_API_ENDPOINT=https://api.fairfax.proof.com ghcr.io/tsarlewey/proof-cli

Arguments after the image name go to proof mcp, e.g. --read-only. PROOF_API_ENDPOINT overrides the configured endpoint in any mode; leave it unset for production.

Agents using the shell can follow skills/proof/SKILL.md. Output is JSON (--pretty=false for compact), and API errors exit 1 with the response body on stderr. Point at the sandbox while testing: proof config set-endpoint https://api.fairfax.proof.com.

Getting Started

1. Configuration

Before using the CLI, you need to configure your API key:

# Set your API key

proof config set-api-key YOUR_API_KEY

Or set via environment variable

export PROOF_API_KEY=YOUR_API_KEY

Verify your configuration

proof config get

In order to get an API Key, you'll need an account with API Usage. You can get that here - https://www.proof.com/pricing#business

After your account is created and upgrade use https://dev.proof.com/docs/api-keys to setup your key.

OAuth 2.0 Authentication

The CLI supports OAuth 2.0 client credentials flow for secure API authentication:

# Configure OAuth credentials

proof config set-oauth [--scope="read write"]

Test OAuth authentication

proof config test-oauth

Disable OAuth (fallback to API key)

proof config disable-oauth

OAuth tokens are automatically refreshed before expiration (5-minute buffer).

2. Basic Usage

The CLI is organized into three main API groups:

• business - Business API operations (transactions, documents, webhooks, notaries, etc.)
• real-estate - Real Estate/Mortgage API operations
• scim - SCIM API operations for user management

# Get help for any command

proof --help proof business --help proof real-estate --help proof scim --help

API Reference

Business API

The Business API provides comprehensive transaction and document management capabilities.

Transactions

# List all transactions

proof business transactions list

List with filtering

proof business transactions list --limit 10 --status completed

Get a specific transaction

proof business transactions get

Create a new transaction

proof business transactions create \ --email "signer@example.com" \ --first-name "John" \ --last-name "Doe" \ --document "/path/to/document.pdf" \ --name "Contract Signing" \ --draft

Multiple documents, scheduled notary meeting, and a redirect

proof business transactions create \ --email "signer@example.com" \ --document "/path/to/deed.pdf" \ --document "/path/to/rider.pdf" \ --notary-meeting-time "2026-09-02T15:30:00Z" \ --allowed-notary-states "CA,NY" \ --notary-note "Verify the property address" \ --payer sender \ --idv-use-case ACCOUNT_RECOVERY \ --recipient-details-config "name=locked" \ --redirect-url "https://example.com/done"

Multiple signers, from a JSON file holding an array of signer objects

(max 10, each needs at least an email). --email stays the primary signer.

proof business transactions create \ --email "primary@example.com" \ --document "/path/to/document.pdf" \ --signers-file ./signers.json

Replace a draft transaction (PUT) -- anything you omit reverts to default

proof business transactions update \ --name "Contract Signing (revised)" \ --expiry "2026-09-08T10:00:00Z"

Change individual fields and leave the rest alone (PATCH)

proof business transactions patch --expiry "2026-09-15T10:00:00Z"

Reorder documents already attached to a draft

proof business transactions patch \ --document-order "doc_abc123=1" \ --document-order "doc_def456=2"

See the full parameter set

proof business transactions create --help

Activate a draft transaction

proof business transactions activate

Delete a transaction

proof business transactions delete

Cancel a transaction

proof business transactions cancel

Documents

# Add a document to a transaction

proof business documents add /path/to/document.pdf \ --filename "Contract.pdf" \ --requirement "esign" \ --esign-required

Apply a specific template instead of automatic matching

proof business documents add /path/to/document.pdf --template-id

Get a document

proof business documents get

Get document as hosted URL (after completion)

proof business documents get --encoding uri

Delete a document

proof business documents delete

Webhooks

# List webhooks (v2)

proof business webhooks list

Get webhook details

proof business webhooks get-v2

Create a webhook

proof business webhooks create \ --url "https://example.com/webhook" \ --name "Transaction Updates" \ --events "transaction.created,transaction.completed"

Update a webhook

proof business webhooks update \ --url "https://new-url.com/webhook"

Delete a webhook

proof business webhooks delete

Get webhook events

proof business webhooks events

List available event subscriptions

proof business webhooks subscriptions

Notaries

# List notaries

proof business notaries list

List notaries by state

proof business notaries list --state CA

Get notary details

proof business notaries get

Create a notary

proof business notaries create \ --email "notary@example.com" \ --first-name "Jane" \ --last-name "Smith" \ --state "CA"

Delete a notary

proof business notaries delete

Templates

# List document templates

proof business templates list

List with pagination

proof business templates list --limit 50 --offset 100

Cost Centers

# List cost centers, then attribute a transaction with --cost-center-id

proof business cost-centers list proof business transactions create --email a@b.com --cost-center-id

Referrals

# Create a referral campaign

proof business referrals create \ --name "Partner Referrals" \ --cover-payment \ --redirect-url "https://example.com/signup"

Generate a referral code

proof business referrals generate-code \ --expires-at "2024-12-31T23:59:59Z"

Integrations

# Create an Adobe integration

proof business integrations create \ --name "ADOBE" \ --org-id "your-org-id" \ --account-id "adobe-account-id" \ --environment "production"

Create a DocuTech integration

proof business integrations create \ --name "DOCUTECH" \ --org-id "your-org-id"

Real Estate API

The Real Estate API specializes in mortgage and real estate transaction management.

Transactions

# List real estate transactions

proof real-estate transactions list

List with filtering

proof real-estate transactions list --status "in_progress" --limit 20

Get transaction details

proof real-estate transactions get

Create a transaction

proof real-estate transactions create \ --type "purchase" \ --file-number "RE-2024-001" \ --loan-number "LN-2024-001"

Place an order for a transaction

proof real-estate transactions place-order

Cancel a transaction

proof real-estate transactions cancel

Templates

# List templates

proof real-estate templates list

Cost Centers

proof real-estate cost-centers list

proof real-estate transactions create --cost-center-id

Documents

# List documents

proof real-estate documents list

Get document details

proof real-estate documents get

Upload a document

proof real-estate documents upload /path/to/document.pdf \ --type "purchase_agreement" \ --external-id "PA-001"

Webhooks

# List real estate webhooks

proof real-estate webhooks list

Create a webhook

proof real-estate webhooks create "https://example.com/re-webhook" \ --subscriptions "transaction.created,document.uploaded"

Address Verification

# Verify an address

proof real-estate verify-address \ --line1 "123 Main St" \ --city "San Francisco" \ --state "CA" \ --postal-code "94102"

SCIM API

The SCIM API provides standardized user management capabilities.

Users

# List users in an organization

proof scim users list

List with pagination

proof scim users list --start-index 1 --count 25

Get user details

proof scim users get

Create a user

proof scim users create \ --username "user@example.com" \ --given-name "John" \ --family-name "Doe" \ --email "user@example.com" \ --active

Update a user (full replacement)

proof scim users update \ --username "updated@example.com" \ --given-name "Jane"

Patch a user (partial update); --operation is repeatable, format op:path[:value]

proof scim users patch \ --operation 'replace:active:false'

Delete a user

proof scim users delete

Schemas

# Get user schema

proof scim schemas user

Get service provider configuration

proof scim schemas service-provider-config

Get resource types

proof scim schemas resource-types

Security Events API

Read the organization's OCSF-formatted security event log.

# List recent security events

proof logs list

Page through results

proof logs list --limit 100 proof logs list --cursor

Filter

proof logs list --since 2026-01-01T00:00:00Z proof logs list --class-uid 1001 --severity-id 3

Certificates API

Issue, use, and revoke organization certificates.

# List certificates

proof certificates list --limit 25 --offset 0

Get one certificate

proof certificates get

Issue a certificate with a Pr