Documentation

Quick Start

Step 1: Install

npm install @proofxhq/agentpass

Step 2: Register

const { Client, register } = require('@proofxhq/agentpass');

const account = await register({
  email: 'you@company.com',
  name: 'Your Name',
  password: 'SecurePass123!',
  company: 'Your Company'
});

// Save your API key securely
console.log('API Key:', account.apiKey);

Step 3: Create an Agent

const client = new Client({ apiKey: account.apiKey });

const agent = await client.createAgent({
  name: 'procurement-bot',
  scope: ['payments']
});

// IMPORTANT: Save the agent private key securely (shown only once)
console.log('Agent ID:', agent.id);
console.log('Private Key:', agent.agentPrivateKey); // Store in KMS/vault
console.log('Trust Score:', agent.trust.score);

Step 4: Make a Payment

const tx = await client.pay({
  agentId: agent.id,
  to: 'aws.amazon.com',
  amount: 5000,       // $50.00 in cents
  currency: 'usd',
  description: 'EC2 instance'
});

console.log('TX:', tx.transactionId);
console.log('Signed:', tx.verified);   // cryptographic signatures
console.log('Hash:', tx.hash);         // SHA-256 chain

Step 5: Prove Identity (for third-party stores)

// Agent proves it is who it claims to be
const proof = await client.proveIdentity(
  agent.id,
  agent.agentPrivateKey  // Never leaves your machine
);

console.log('Verified:', proof.verified);
console.log('Trust:', proof.trust.score);
console.log('Recommendation:', proof.recommendation);

Trust Levels

Agents start at L1 and earn higher trust through consistent, legitimate behaviour. Trust score is computed from 5 weighted dimensions.

Scoring Dimensions

What Changes Trust?

Identity Verification

Prevent agent impersonation with cryptographic challenge-response. Each agent has its own cryptographic key pair. The private key never leaves the developer's infrastructure.

How It Works

What Gets Caught