API Quick Start

Prerequisites

• curl or any HTTP client
• A valid email address
• 5 minutes

Step 1: Register

curl -X POST https://api.boxowl.me/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "YourSecurePassword123!",
    "handle": "yourname"
  }'

Response:

{
  "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "handle": "yourname"
}

Step 2: Authenticate

curl -X POST https://api.boxowl.me/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "YourSecurePassword123!"
  }'

Response:

{
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
  "expiresIn": 86400
}

If MFA is enabled, include the mfaCode field with your TOTP code.

Step 3: Read Your Vault

curl https://api.boxowl.me/api/v1/vault/identity \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Response:

{
  "firstName": "Your",
  "lastName": "Name",
  "email": "you@example.com",
  "phone": "+1-555-0100"
}

Next Steps

• Read the full API Reference for all endpoints and schemas
• Learn about Browser Extension Setup to autofill forms
• Explore Features to see what else BoxOwl can do