Use Cases Pricing Docs About
Get Started
Ready to start creating map animations? Get Started Free →

Authentication

All API endpoints require authentication. Choose between API keys (recommended for server-side) or JWT tokens (for user-facing apps).

Unauthenticated requests will receive a 401 Unauthorized response.

API Key Authentication (Recommended)

Use API keys for server-to-server integrations. Generate keys in your dashboard. Keys start with gr_live_ for production or gr_test_ for sandbox.

curl -X POST https://api.georender.io/v1/render \
  -H "Authorization: Bearer gr_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"waypoints": [...]}'

API Key Security

JWT Token Authentication

Use JWT tokens for user-facing applications where you need per-user authentication. Tokens expire after 24 hours.

Register a New Account

POST /v1/auth/register

{
  "email": "[email protected]",
  "password": "your-password",
  "name": "Your Name"
}

Login to Existing Account

POST /v1/auth/login

{
  "email": "[email protected]",
  "password": "your-password"
}

// Response
{
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "user": {
    "id": "user_abc123",
    "email": "[email protected]",
    "name": "Your Name"
  }
}

Using the Token

curl -X POST https://api.georender.io/v1/render \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{"waypoints": [...]}'

Email Verification

New accounts must verify their email address before creating renders. A verification email is sent automatically upon registration.

Verification Flow

  1. Register - Account created with emailVerified: false
  2. Check inbox - Verification email sent automatically
  3. Click link - Opens verification URL with token
  4. Verified - Account can now create renders

Resend Verification Email

POST /v1/auth/resend-verification
Authorization: Bearer <access_token>

// Response
{
  "message": "Verification email sent",
  "expires_in_hours": 24
}

Authentication Errors

StatusError CodeDescription
401 AUTHENTICATION_REQUIRED No token or API key provided
401 INVALID_TOKEN Token is malformed or expired
401 INVALID_API_KEY API key not found or revoked
403 EMAIL_NOT_VERIFIED Render blocked - verify email first
Note: Unverified accounts can still login and access the dashboard, but cannot create render jobs until verified.