The core RiskOS™ Evaluation API — start, retrieve, update, and manage evaluations, and download captured documents.
The Evaluation API is the core of RiskOS™: you submit data and a workflow name, and RiskOS™ returns a decision with scores, reason codes, and enrichment data. For a task-oriented walkthrough, see Integrating with RiskOS™.
Endpoints
| Endpoint | Description |
|---|---|
| Start an Evaluation | Submit an evaluation request and run a workflow |
| Get an Evaluation | Retrieve the state and results of an evaluation |
| Update an Evaluation | Add data to a paused or in-progress evaluation |
| Update an Evaluation State | Update decision, status, sub_status, notes, or attachments |
| Download Evaluation Documents | Download documents captured during an evaluation |
Related
- Customer Metadata — the optional
customer_metadatarequest field, echoed back on responses and webhooks