Risko API Documentation

Generated from the Risko API Markdown docs.

Risko API — Endpoint Usage (Production)

Base URL

https://api.risko.ai

Authentication

All requests require the following header:

Authorization: Bearer

Example

-H 'Authorization: Bearer <API_KEY>'

Common error responses

Invalid or missing API key

{"success":false,"error":"Invalid API key","code":"UNAUTHORIZED"}

Wrong authorization format

{"success":false,"error":"Invalid authorization format. Expected: Bearer <token>","code":"UNAUTHORIZED"}

1) Health Check

GET /health

cURL

curl -H 'Authorization: Bearer <API_KEY>' \
  'https://api.risko.ai/health'

Response

{"status":"ok","timestamp":"2026-01-27T11:00:03.364Z","environment":"production"}

2) Store Status

GET /api/v1/store-status

Query parameters - shopId (required)

cURL

curl -H 'Authorization: Bearer <API_KEY>' \
  'https://api.risko.ai/api/v1/store-status?shopId=risk-calculator-test-store-3.myshopify.com'

Response

{"success":true,"data":{"hasRiskoApp":true,"shopId":"risk-calculator-test-store-3.myshopify.com"}}

3) Overview

GET /api/v1/overview

Query parameters - shopId (required) - timePeriod (required, example: monthly)

cURL

curl -H 'Authorization: Bearer <API_KEY>' \
  'https://api.risko.ai/api/v1/overview?shopId=03bede-e7.myshopify.com&timePeriod=monthly'

Response

{
  "success": true,
  "data": {
    "timePeriod": "monthly",
    "startDate": "2026-01-01T00:00:00.000Z",
    "endDate": "2026-01-31T23:59:59.999Z",
    "totalOrders": 4105,
    "flaggedPercentage": 35.3,
    "riskDistribution": {
      "fake": { "count": 7, "percentage": 0.2 },
      "highRisk": { "count": 1091, "percentage": 26.6 },
      "mediumRisk": { "count": 353, "percentage": 8.6 },
      "lowRisk": { "count": 2563, "percentage": 62.4 }
    },
    "estimatedSavings": {
      "amount": 37066,
      "currency": "RON",
      "description": "From unclaimed packages this period"
    },
    "deliverySuccessRate": {
      "current": 18.3,
      "previous": 53.3,
      "change": -35.1,
      "trend": "increasing"
    }
  }
}

4) Customer Profile

GET /api/v1/customer-profile

Query parameters - shopId (required) - shopifyCustomerId (required)

cURL

curl -H 'Authorization: Bearer <API_KEY>' \
  'https://api.risko.ai/api/v1/customer-profile?shopId=03bede-e7.myshopify.com&shopifyCustomerId=23502957478220'

5) Order Risk Score

GET /api/v1/order-risk-score

Query parameters - shopId (required) - orderId (required)

cURL

curl -H 'Authorization: Bearer <API_KEY>' \
  'https://api.risko.ai/api/v1/order-risk-score?shopId=jttisr-4u.myshopify.com&orderId=7046445171021'

© Risko API Documentation