Embed cyber risk scoring, branch-level breakdowns, and cost/benefit modeling into your own products. A plug-and-play REST API that returns quantified risk in JSON format.
Confirms the RQE calculation engine is reachable and returns the current API version. Use this for integration health checks and uptime monitoring.
Accepts cyber risk assumptions and returns structured financial impact outputs, confidence scoring, and assumption flags. Implements the Binary³ five-step RQE financial methodology as defined in the research white paper.Read the methodology →
| Field | Type | Required | Description |
|---|---|---|---|
directCosts | number | Yes | Direct attack costs: IR, forensics, legal, regulatory fines |
indirectCosts | number | Yes | Indirect costs: revenue loss, churn, reputational damage |
cumulativeProbability | number | Bernoulli only | Probability of at least one attack over the time horizon (0–1) |
timeHorizonYears | number | Bernoulli only | Years over which cumulative probability is estimated (min 1) |
programCost | number | Yes | Total cybersecurity program cost over its full lifespan |
programLifespanYears | number | Yes | Expected program lifespan in years (min 1) |
effectiveness | number | Yes | Program risk reduction coefficient (0.0–1.0). Empirical range: 0.30–0.85 |
probabilityModel | string | Yes | "bernoulli" or "poisson" |
lambda | number | Poisson only | Expected attacks per year. Required when probabilityModel is "poisson" |
Use when you have a cumulative attack probability estimate over a multi-year horizon. Standard actuarial approach.
Use when threat intelligence provides an expected annual attack frequency (lambda). Mathematically preferred for cyber risk.
| Condition | HTTP Response |
|---|---|
| Any numeric field is negative | 400 — field name and "must be a positive number" |
effectiveness outside 0–1 | 400 — "effectiveness must be between 0.0 and 1.0" |
cumulativeProbability outside 0–1 | 400 — "cumulativeProbability must be between 0.0 and 1.0" |
timeHorizonYears below 1 | 400 — "timeHorizonYears must be at least 1" |
programLifespanYears below 1 | 400 — "programLifespanYears must be at least 1" |
probabilityModel is "poisson" and lambda is null or missing | 400 — "lambda is required when probabilityModel is poisson" |
probabilityModel is not "bernoulli" or "poisson" | 400 — "unsupported probabilityModel value" |
Every response includes a confidence score (0–100) reflecting the reliability of the supplied assumptions. The score begins at 75 and is adjusted as follows.
| Condition | Adjustment |
|---|---|
indirectCosts > 4× directCosts | −10 |
cumulativeProbability > 0.80 | −10 |
effectiveness > 0.85 | −10 |
programLifespanYears > 5 | −8 |
probabilityModel is "poisson" with valid lambda | +5 |
effectiveness between 0.30–0.60 (conservative range) | +3 |
The API returns structured warning objects when inputs fall outside empirically validated ranges. Flags are informational and do not block the response.
| Severity | Field | Trigger Condition |
|---|---|---|
| warning | indirectCosts | Greater than 4× directCosts |
| warning | cumulativeProbability | Greater than 0.80 |
| warning | effectiveness | Greater than 0.85 |
| warning | effectiveness | Less than 0.30 |
| warning | programLifespanYears | Greater than 5 years |
| warning | grossMarginImpact | Calculated value is negative |
| info | probabilityModel | Bernoulli model used; Poisson recommended when lambda is available |
{ "domain": "demo-target.example.com", "scan_id": "rqe_20260423_001", "timestamp": "2026-04-23T17:00:00Z", "risk_score": 72, "exposure_usd": { "low": 6200, "high": 8700, "currency": "USD" }, "top_risk": "SSL certificate expiring in 18 days", "priority_fix": "Renew SSL certificate immediately", "findings_count": 4, "confidence": "high", "tier": "sandbox" }
https://api.binarycubed.com/rqe/v1
Sandbox environment available by request.
Get started with the RQE API in minutes.
curl -X POST https://api.binarycubed.com/rqe/v1/score \
-H "Authorization: Bearer YOUR_RQE_API_KEY" \
-H "X-Tenant-ID: YOUR_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{
"asset_value": 250000,
"likelihood": 0.35,
"impact": 0.6,
"category": "credential_exposure",
"branch": "identity"
}'
import requests
response = requests.post(
"https://api.binarycubed.com/rqe/v1/score",
headers={
"Authorization": "Bearer YOUR_RQE_API_KEY",
"X-Tenant-ID": "YOUR_TENANT_ID",
"Content-Type": "application/json"
},
json={
"asset_value": 250000,
"likelihood": 0.35,
"impact": 0.6,
"category": "credential_exposure",
"branch": "identity"
}
)
print(response.json())
const response = await fetch('https://api.binarycubed.com/rqe/v1/score', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_RQE_API_KEY',
'X-Tenant-ID': 'YOUR_TENANT_ID',
'Content-Type': 'application/json'
},
body: JSON.stringify({
asset_value: 250000,
likelihood: 0.35,
impact: 0.6,
category: 'credential_exposure',
branch: 'identity'
})
});
const data = await response.json();
console.log(data);
{
"risk_score": 68,
"branch": "identity",
"branch_breakdown": {
"identity": 68,
"perimeter": 0,
"logging": 0
},
"likelihood": 0.35,
"impact": 0.60,
"severity_multiplier": 1.2,
"cost_benefit": {
"potential_loss": 52500,
"mitigation_cost": 8500,
"roi": 5.18
},
"recommendations": [
"Rotate affected keys and credentials.",
"Enable multi-factor authentication.",
"Add continuous monitoring for anomalous logins."
]
}
Core endpoints for risk scoring, batch processing, and scenario modeling.
| Endpoint | Method | Description |
|---|---|---|
/health |
GET | API health check and status |
/overview |
GET | Tenant-level risk overview |
/score |
POST | Compute single asset risk score |
/batch/score |
POST | Batch score up to 100 assets |
/scenario/what-if |
POST | Run what-if CBA modeling |
/timeline |
GET | Historical risk timeline |
These API endpoints mirror the data available in the Binary³ Dashboard 2.0 interface.
View DashboardFor solo developers & testing
For early-stage products
For commercial deployments
Overages billed at $0.002 per additional API call.
1 credit
GET, POST to /score, /overview, /timeline
2 credits
Branded risk report generation
| Add-on | Description | Price |
|---|---|---|
| Branded PDF Templates | Custom-branded risk report templates | $50/mo |
| Auto-scan Webhook | Scheduled scans with webhook delivery | $25/mo |
| Slack/Email Alerts | Real-time threshold notifications | Included |
| Dedicated IP | Static IP for firewall whitelisting | $100/mo |
risk_t = likelihood × impact × weight_by_category × severity_multiplier
KeySweep + RedLure findings
branch: "identity"
Phoros + MicroDefend findings
branch: "perimeter"
LogSentinel + ForensIQ findings
branch: "logging"
The RQE API returns branch-level and overall risk scores mirroring this structure.
Get your API key and start building.
Prefer email? Contact support@binarycubed.com
Our risk quantification methodology is built on industry-standard frameworks including FAIR, NIST CSF, and ISO 27005.