CERNIQ API Documentation

curl -X POST https://api.cerniq.io/api/v1/analyze \
  -H "Authorization: Bearer ck_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "institutionName": "Cooperativa Oriental",
    "institutionType": "cooperativa",
    "framework": "cossec",
    "period": "Q1-2026",
    "rows": [
      {
        "category": "asset",
        "subcategory": "commercial_loans",
        "name": "CRE - Retail Center",
        "balance": 10.0,
        "rate": 6.50,
        "duration": 5.0,
        "rateType": "fixed"
      },
      {
        "category": "asset",
        "subcategory": "investment_securities",
        "name": "US Treasury Notes",
        "balance": 16.0,
        "rate": 4.25,
        "duration": 2.0,
        "rateType": "fixed"
      },
      {
        "category": "liability",
        "subcategory": "savings_deposits",
        "name": "Regular Savings",
        "balance": 12.0,
        "rate": 1.50,
        "duration": 0.25,
        "rateType": "variable"
      },
      {
        "category": "liability",
        "subcategory": "time_deposits",
        "name": "12-Month CDs",
        "balance": 8.0,
        "rate": 3.00,
        "duration": 1.0,
        "rateType": "fixed"
      }
    ]
  }'

import requests

API_KEY = "ck_live_YOUR_API_KEY"
BASE_URL = "https://api.cerniq.io/api/v1"

# Run analysis
response = requests.post(
    f"{BASE_URL}/analyze",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "institutionName": "Cooperativa Oriental",
        "institutionType": "cooperativa",
        "framework": "cossec",
        "period": "Q1-2026",
        "rows": [
            {
                "category": "asset",
                "subcategory": "commercial_loans",
                "name": "CRE Portfolio",
                "balance": 45.0,
                "rate": 6.50,
                "duration": 4.5,
                "rateType": "fixed"
            },
            # ... more rows
        ]
    }
)

result = response.json()
analysis = result["data"]

print(f"Exam Readiness: {analysis['examReadinessScore']}/100")
print(f"Overall Status: {analysis['overallStatus']}")

for ratio in analysis["ratios"]:
    print(f"  {ratio['name']}: {ratio['value']}{ratio['unit']} [{ratio['status']}]")

# Retrieve later
analysis_id = analysis["analysisId"]
stored = requests.get(
    f"{BASE_URL}/analyses/{analysis_id}",
    headers={"Authorization": f"Bearer {API_KEY}"}
).json()

const API_KEY = "ck_live_YOUR_API_KEY";
const BASE_URL = "https://api.cerniq.io/api/v1";

// Run analysis
const response = await fetch(`${BASE_URL}/analyze`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    institutionName: "Cooperativa Oriental",
    institutionType: "cooperativa",
    framework: "cossec",
    period: "Q1-2026",
    rows: [
      {
        category: "asset",
        subcategory: "commercial_loans",
        name: "CRE Portfolio",
        balance: 45.0,
        rate: 6.50,
        duration: 4.5,
        rateType: "fixed",
      },
      // ... more rows
    ],
  }),
});

const { data } = await response.json();

console.log(`Exam Readiness: ${data.examReadinessScore}/100`);
console.log(`Duration Gap: ${data.durationGap.durationGap} years`);
console.log(`LCR: ${data.lcr.lcr}% (${data.lcr.status})`);

// CSV upload
const formData = new FormData();
formData.append("file", csvFile);
formData.append("institutionName", "Cooperativa Oriental");
formData.append("institutionType", "cooperativa");
formData.append("framework", "cossec");
formData.append("period", "Q1-2026");

const csvResponse = await fetch(`${BASE_URL}/analyze/csv`, {
  method: "POST",
  headers: { "Authorization": `Bearer ${API_KEY}` },
  body: formData,
});