API Reference

The Simplr API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://api.simplr-ai.com/v1

Authentication

Client ingestion and risk checks use an API key:

curl https://api.simplr-ai.com/v1/check \
  -H "X-API-Key: sk_live_xxxxxxxxxxxxx"

Portal management endpoints use Authorization: Bearer <access-token>. A small set of release/status and OAuth endpoints use dedicated tokens, signatures, or public access. See Authentication for details.

Core Endpoints

Endpoint	Method	Description
/check	POST	Run a fraud check
/check/bulk	POST	Run multiple checks
/check/{id}	GET	Get check result
/check/sandbox	GET	List predictable sandbox values and examples

Edge Device Logs

Endpoint	Method	Description
/edge/logs	POST	Ingest logs from edge devices
/edge/logs	GET	Query logs with filters
/edge/logs/search	GET	Full-text search logs
/edge/devices/register	POST	Register a new device
/edge/devices	GET	List registered devices
/edge/devices/:id/heartbeat	POST	Send device heartbeat
/edge/overview	GET	Dashboard statistics
/edge/errors	GET	Error groups (Sentry-style)
/edge/trends	GET	Log volume trends
/edge/alerts	GET/POST/DELETE	Manage alerts

Request Format

JSON client requests should include:

Content-Type: application/json
X-API-Key: sk_live_xxxxxxxxxxxxx

Use a test key for non-billable integration testing. Portal endpoints replace X-API-Key with a bearer token, and public-key SDK traffic uses the appropriate pk_live_ or pk_test_ key.

Response Format

All responses follow this structure:

{
  "success": true,
  "message": "Check completed",
  "content": {
    // Response data
  }
}

Error responses:

{
  "success": false,
  "message": "Email is required",
  "code": "invalid_request",
  "content": {
    "field": "email"
  }
}

HTTP Status Codes

Code	Description
200	Success
400	Bad request - invalid parameters
401	Unauthorized - invalid or missing API key
403	Forbidden - insufficient permissions
404	Not found
429	Rate limit exceeded
500	Server error

Rate Limits

See Rate Limits for details on request limits.

SDKs

We provide official SDKs:

• JavaScript SDK
• Flutter SDK
• Node.js SDK

OpenAPI Specification

The full OpenAPI spec is available at:

https://api.simplr-ai.com/openapi.json

Interactive documentation:

https://api.simplr-ai.com/docs