Developer Reference

API Documentation

Integrate PayCanary risk scoring, crisis triage, and AI agent capabilities directly into your application. All endpoints return consistent JSON with the { success, data?, error? } pattern.

Base URL

https://api.paycanary.io/v1

Future public API — currently embedded in the application.

Authentication

Authorization: Bearer pc_xxxxx...

Generate API keys in Dashboard → Settings. Public endpoints require no auth.

Response Format

{ success: boolean, data?, error? }

All responses are JSON. Errors include a human-readable message.

Rate Limits

Per-endpoint

Limits are documented on each endpoint below. 429 returned when exceeded.

Authentication

Authenticated endpoints require an API key passed as a Bearer token in the Authorization header.

Generate a key

Go to Dashboard → Settings → API Keysand click “Generate new key”. Copy the key immediately — it is only shown once.

Pass as Bearer token

curl https://api.paycanary.io/v1/agents/outputs \
  -H "Authorization: Bearer pc_your_api_key_here"

Rate limits

API key authenticated requests are limited to 100 requests per hour per key. Exceeding this returns a 429 status. Individual endpoints may have stricter limits noted in their reference below.

Error Responses

All errors follow the same shape. HTTP status codes are standard (400 for bad requests, 401 for auth failures, 429 for rate limits, 500 for server errors).

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again in 43 seconds.",
    "retry_after": 43
  }
}

Endpoints

Click an endpoint to expand its full reference.

Need help integrating?

Reach out and we will walk you through it.

Contact Support