BRE connector — overview
The BRE connector is Ark's business rules engine. It exposes a REST API to manage rule definitions (CRUD) and to evaluate them against supplied input. Rules are authored as JDM (JSON Decision Model) decision graphs and evaluated in-process. There is no external vendor — this is a self-contained internal service.
This is the connector BRE (the in-process JDM rules connector). It is distinct from the platform's internal routing rules; do not conflate the two.
What it does
| Capability | Endpoint |
|---|---|
| Evaluate a rule | POST /v1/rules/{ruleKey}/evaluate |
| List rules | GET /v1/rules |
| Get a rule (with JDM) | GET /v1/rules/{ruleKey} |
| Create a rule | POST /v1/rules |
| Update a rule | PUT /v1/rules/{ruleKey} |
| Deactivate a rule | DELETE /v1/rules/{ruleKey} |
See endpoints for how to call them and lifecycle for a rule's status/versioning.
Shape
- Self-contained. No external API; rule definitions are stored locally and execute in-process.
- Versioned, cached decisions. Each rule has a
version(incremented on update); compiled decisions are cached per version so repeat evaluations skip recompilation. - Sensitive input. Evaluation
context/resultmay contain AML/KYC data and are never logged.
Where to read next
| You want… | Doc |
|---|---|
| How to call the API | endpoints (non-dev) |
| A rule's status & versioning | lifecycle (non-dev) |
| How it's built and per-endpoint internals | architecture (dev) |
| How to build, run, test, and regenerate clients | development (dev) |
| Quirks and caveats | notes (dev) |
The formal request/response contract is the connector's OpenAPI specification (the Business Rules
Engine API, openapi/source/connector/bre/bre.yml); this doc set does not restate it.