Vantage API · v1

Score any record.
In your system.

Vantage exposes its full risk intelligence via REST API. Query a single record or batch hundreds. Integrate the score into your billing platform, case management tool, or CRM, without logging into another dashboard.

Request API access See the endpoints ↓

POST /api/v1/score

POST /api/v1/score HTTP/1.1
Authorization: Bearer vnt_live_••••••••

{
  "reference": "METER-00124",
  "data": {
    "account_id": "ACC-8821"
  }
}

{
  "reference":   "METER-00124",
  "found":      true,
  "risk_score": 82.5,
  "risk_band":  "high", HIGH
  "confidence": 0.91,
  "flags": [
    "consumption_below_floor",
    "feeder_variance_high"
  ],
  "recommendation":
    "REVIEW: High risk score.",
  "scored_at": "2026-11-03T09:14:22Z"
}

curl -X POST \
  https://vantage.priimal.com/api/v1/score \
  -H "Authorization: Bearer vnt_live_••••" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "METER-00124",
    "data": {}
  }'

How it works

From a reference to a risk score in one call

Vantage has already scored your records. The API retrieves that intelligence and serves it directly into the system you're already working in.

Authenticate

Your API key is scoped to your tenant and module. Pass it as a Bearer token. All requests are logged and rate-limited per key.

Send a reference

POST a record reference (the same ID your billing or field system already uses). Send one or up to 100 at a time with the batch endpoint.

Get risk intelligence

Receive a risk score, risk band, confidence level, active fraud flags, and a plain-English recommendation. Display it, route it, or trigger a workflow.

API Reference

Three endpoints. Everything you need.

The full API surface is intentionally narrow. One endpoint to query a record, one for batches, one for tenant health.

POST/api/v1/score

Query the most recent Vantage score for a single record reference. Returns the full risk profile: score, band, confidence, active fraud flags, and a recommendation string.

{
  "reference":      "METER-00124",
  "found":         true,
  "risk_score":    82.5,   // 0–100
  "risk_band":     "high",
  "confidence":    0.91,
  "value_at_risk": 4820.00,
  "flags": [
    "consumption_below_floor",
    "feeder_variance_high"
  ],
  "recommendation": "REVIEW: High risk score.",
  "scored_at":     "2026-11-03T09:14:22Z"
}

POST/api/v1/batch

Score up to 100 records in a single call. Missing references return "found": false without erroring. Results are returned in the same order as the request array.

// Request
{
  "references": ["METER-00124", "METER-00125"]
}

// Response
{
  "count":   2,
  "results": [
    { "reference": "METER-00124",
      "found": true, "risk_score": 82.5,
      "risk_band": "high",
      "recommendation": "REVIEW: High risk score." },
    { "reference": "METER-00125",
      "found": false }
  ]
}

GET/api/v1/status

Returns your tenant's current state: name, active module, tier, total scored records, and high-risk count. Use as a health check or to confirm your key is valid before a batch run.

{
  "status":        "ok",
  "tenant":        "Acme Energy Ltd",
  "module":        "ntl",
  "tier":          "growth",
  "total_scored":  14820,
  "high_risk":     412,
  "api_version":   "v1"
}

Continuous monitoring

From project work to always-on intelligence

The standard Vantage engagement is project-based. The API changes that entirely: your systems score continuously, without manual runs.

⚡

Score at the point of transaction

Connect your billing or provisioning system to the score endpoint. Every new account, meter read, or claim gets scored the moment it enters your system.

Risk score on account creation or activation
Automatic flag on high-risk transactions before posting
Webhook or synchronous: your architecture choice
No PII leaves your system; we match on your reference IDs

🔁

Push scores back to your CRM or case tool

Use the batch endpoint on a scheduled basis to refresh scores across your active portfolio. Your system of record stays current as Vantage re-scores from new data.

Nightly or intra-day batch refresh via cron or scheduler
Update case priority based on new risk score automatically
Sync high-risk count to your ops dashboard
Trigger field dispatch when a score crosses a threshold

🔌

Pre-built connector (coming Q1 2027)

A lightweight plugin that handles auth, retry, and score caching. Available for common billing platforms and CRMs across utilities and telecoms.

Drop-in module, no custom integration work
Configurable thresholds per risk band
Built-in retry and queue for resilience
Join the waitlist for early access

📊

Audit-ready request logging

Every API call is logged to your tenant's request log: endpoint, timestamp, response code. Available in your Vantage dashboard and exportable for compliance reporting.

Full request log in Vantage dashboard
Exportable for compliance and audit trails
Per-key usage breakdown
Rate limit status on every response header

Where it fits

Your systems, not ours

The API is designed to disappear into whatever toolchain your operations team already runs.

Billing systems

Flag before posting

Call /score at the billing run stage. Route high-risk accounts to a hold queue before revenue is posted. Integrates with SAP, Oracle CC&B, or any billing platform via API.

Case management

Auto-prioritise cases

Feed risk scores and flags directly into your SIU or field operations tool. Cases surface ranked by Vantage score rather than by age or assignment queue.

CRM & account management

Risk-aware account views

Display the current Vantage score alongside every account record. Teams see risk context without switching platforms or waiting for a monthly report.

Field operations

Dispatch by risk, not queue

Batch-score your open field jobs nightly. Push the ranked list to your dispatch system. Inspection resources go to the highest-value sites first.

Operations dashboards

Live risk metrics

Use /status to pull your total scored count and high-risk tally into any ops dashboard. One authenticated call returns current portfolio risk in milliseconds.

Data pipelines

Enrich at ingestion

Add Vantage scores as a step in your ETL or data pipeline. Records arrive at the warehouse already tagged with risk band, flags, and scored timestamp.

Score any record.In your system.