Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ivory.finance/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Registration does not require any prior credentials. Once registered, use the returned access_token to authenticate all subsequent API calls.

​
Request body

FieldRequiredDescription
emailYesValid email address — must be unique
nameYesDisplay name
passwordYesPlain-text password (bcrypt-hashed server-side)
curl -X POST https://api.ivory.finance/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "analyst@hedgefund.com",
    "name": "Jane Analyst",
    "password": "SecurePass123!"
  }'

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 142,
    "email": "analyst@hedgefund.com",
    "name": "Jane Analyst",
    "tier": "free",
    "api_key": "ivk_live_abc123xyz789"
  }
}
Registration automatically:
  • Creates a Kong consumer for API key management
  • Assigns the user to the free consumer group
  • Generates an initial API key (returned in user.api_key)
  • Issues a 15-minute access_token and a 7-day refresh_token