Skip to main content
Version: 2.0.0

Enygma SuperAPI

Introduction

Enygma SuperAPI runs scoped data-gathering jobs for each risk evaluation, then canonical scoring and CTP (Customer Trust Profile) so you get unified risk and trust signals in one flow.

API specification and explorers

The API ships its own machine-readable spec and two interactive explorers, all served from the same base URL as the API itself:

These reflect the deployed API at any given time and are the source of truth if anything here looks out of date.

CTP and scoring

Every risk evaluation runs two downstream evaluations after your scoped data-gathering jobs complete:

  • Canonical scoring (scoring) — fraud, trust, and compliance-style scores produced by the Enygma scoring engine.
  • CTP (Customer Trust Profile) (ctpEvaluation) — trust probability, confidence, and a decision recommendation (approve / review / block).

Control how you receive these results with scoringMode on POST /risk_evaluations (and when adding jobs):

  • HTTP_CALLBACK (default) — scoring and CTP are computed asynchronously; use webhooks or poll GET /risk_evaluations/{id} for full results.
  • REALTIME — the API waits (up to about 15 seconds) for workers to finish and publish scoring + CTP to Redis, then returns them in the same response when successful. On timeout or internal errors, entries may appear under unscopableJobs with SCORING_TIMEOUT_ERROR or SCORING_INTERNAL_ERROR for the scoring job type.

Authentication

Security Scheme Type:

apiKey

Header parameter name:

X-API-KEY