Skip to main content

Base URL

https://finceptbackend.share.zrok.io

Authentication

All endpoints require the X-API-Key header unless specified otherwise.
X-API-Key: fk_user_your_api_key_here

Response Format

All responses follow this standard format:
Success
{
  "success": true,
  "message": "Operation completed successfully",
  "data": { ... }
}
Error
{
  "success": false,
  "message": "Error description",
  "error_code": "ERROR_CODE"
}

Endpoint Categories

Rate Limits

Rate limits vary by account type. See Authentication for details.

Error Codes

CodeDescription
INVALID_API_KEYAPI key is missing or invalid
EXPIRED_KEYGuest API key has expired
RATE_LIMIT_EXCEEDEDToo many requests
INVALID_CREDENTIALSIncorrect email or password
USER_NOT_FOUNDUser does not exist
INSUFFICIENT_CREDITSNot enough credits for operation
SUBSCRIPTION_REQUIREDPremium subscription needed
VALIDATION_ERRORRequest validation failed
INTERNAL_ERRORServer error occurred

Pagination

Endpoints that return lists support pagination:
GET /endpoint?offset=0&limit=20
Response includes pagination metadata:
{
  "success": true,
  "data": {
    "items": [...],
    "total": 100,
    "offset": 0,
    "limit": 20
  }
}

Timestamps

All timestamps are in ISO 8601 format (UTC):
2025-12-24T12:00:00Z