Shadow / Demo Mode — all data is simulated for evaluation. paykx.co.uk ↗
Developer APIs

PAYKX Intelligence APIs

Beyond GO / NO-GO. A full suite of read-only APIs that let you explain decisions, understand corridor health, prove value, and verify trust — for every payment, every time.

How a PAYKX decision flows through the intelligence layer
Payment Intent
POST /api/v1/verify
PAYKX Assessment Engine
7 Signals evaluated
Decision: GO / DEGRADED / NO-GO
Explain API
/signals/:id
Audit API
/audit/export/:id
Impact API
/decision/:id/impact

Intelligence API Reference

Explain
GET /api/v1/signals/{decision_id}

Signal Provenance API

Returns the full provenance of all 7 signals that contributed to a decision. Every signal includes its raw risk value, human label, category, data source, and per-signal confidence. Designed for compliance officers who need to know exactly why a decision was made.

model_version — PAYKX-v1.3.0
evaluated_at — ISO 8601 timestamp
signals[].source — simulation / live
signals[].confidence — 0.70–0.97
signals[].reason_code — e.g. HIGH_FX_VOLATILITY
API key required
Understand
GET /api/v1/corridors/{corridor}

Corridor Intelligence Platform

Returns the current PAYKX assessment of a corridor as a whole — not tied to any single transaction. Shows OPERATIONAL / DEGRADED / IMPAIRED status with fx, network, settlement, liquidity, and compliance signal buckets. Explicitly labels which signals are live vs simulated.

status — OPERATIONAL / DEGRADED / IMPAIRED
data_environment — mixed / simulation
live_signals — count of live feeds
signals.fx / network / settlement
advisory — operator guidance text
API key required
Prove Value
GET /api/v1/decision/{id}/impact

Counterfactual Impact API

Estimates the risk this transaction would have carried if it went unscreened, using PSR/FCA cross-border payment failure benchmarks. Returns risk_exposure_reduced (not "loss avoided" — a legally careful framing) with confidence level and calculation basis.

risk_exposure_reduced — true / false
confidence — high / medium
calculation_basis — benchmark source
intervention_type — PASS_THROUGH / CONDITIONAL_HOLD / BLOCK
risk_reduction — 0.0–1.0
API key required
Verify Trust
GET /api/v1/readiness

Enterprise Readiness Checklist

A public 16-item checklist showing exactly what is production-ready and what is on the roadmap. Sandbox capability is complete. Most startups hide gaps — PAYKX shows them, with timelines. Built for enterprise procurement teams and technical due diligence reviews.

enterprise_readiness — 10/16
sandbox_capability — Complete
production_capability — In progress
checklist[] — ready / planned / not_available
Public — no auth required
Audit
GET /api/v1/decision/{id}/timeline New

Decision Timeline API

Returns a structured event log of every stage during a decision — from request receipt and idempotency check, through signal evaluation and network probe, to verdict and audit persistence. 10 timestamped events per decision. Designed for compliance audits and debugging.

events[].event — e.g. signals_evaluated
events[].time — ISO 8601
events[].duration_ms — stage timing
total_duration_ms — end-to-end
API key required
Replay
POST /api/v1/replay New

Decision Replay API

Submit any historical payment description and get back what PAYKX would have decided at that point. The evidence engine for retrospective compliance review: "Would PAYKX have flagged this?" Returns the full 7-signal breakdown and recommended action against the current model.

verdict.would_have_flagged — true / false
verdict.decision — GO / DEGRADED / NO-GO
verdict.recommended_action
probe_details — full 7-signal breakdown
API key required
Status
GET /api/v1/status/signals

Signal Source Status API

Returns the operational status of every data feed, clearly separated into available today and roadmap. No simulation vs live feeds are mixed — each entry explicitly states its source and last updated date. Enterprise buyers use this for due diligence.

available.feeds[] — today's feeds with status
roadmap.feeds[] — planned feeds with target
environment — sandbox
last_updated — YYYY-MM-DD
Public — no auth required
Organisation New
GET /api/v1/organisation/settings

Organisation Settings API

Returns the calling API key's organisation configuration: permitted corridors, enabled features, rate limits, role definitions, and usage stats. Scoped to the calling key — each operator sees only their own settings. Foundation for multi-tenant enterprise onboarding.

corridors.permitted — GB-NG, NG-GB
features{} — per-feature flags
audit_users[] — role definitions
usage.verifications_this_key
API key required

How PAYKX intelligence compares

Capability PAYKX Rail Typical fraud monitor Card network (Visa/MC)
/signals provenance✓ Full per-signal audit— Black box— Not exposed
Corridor-level health✓ OPERATIONAL / DEGRADED— Transaction only— Not available
Counterfactual impact✓ Risk exposure estimate— Not provided— Not provided
Decision timeline✓ 10-event audit log— Partial at best— Not accessible
Historical replay✓ POST /replay— Rare— Not available
Feed transparency✓ Live vs sim, separated— Not disclosed— Not disclosed
Readiness checklist✓ 16-item public checklist— SOC 2 only— Not applicable
Pre-execution (not post)✓ Before money moves— Post-transaction— At auth layer only

Ready to integrate?

All intelligence APIs are available on your sandbox key. Production access unlocks live feeds and additional corridors.