Rules Evaluation API
API for evaluating Business Rules Engine (BRE) rules against a caller-supplied context object.
Rules are authored and managed via the Administration Configuration API
(/v1/admin/configuration/bre-rules). Only rules with status ACTIVE can
be evaluated; attempting to evaluate a DRAFT or INACTIVE rule returns
404.
Evaluation contract
- The
contextis an arbitrary JSON object. Unknown or missing fields are treated asnullby the rule engine. - Results are deterministic: the same
ruleVersionandcontextalways produce the sameresult. - The response always includes
ruleKeyandruleVersionso callers can correlate results to the exact rule revision that produced them.
Data sensitivity: The context and result fields may contain
sensitive customer data (e.g. AML/KYC inputs and scores). These fields are
never written to logs; only ruleKey and evaluation duration are recorded.
Authentication: OAuth2 client-credentials (scope defined by the platform's IAM configuration).
Error envelope: { errorCode, message, timestamp, traceId } where
errorCode follows the pattern {DOMAIN}{CLASSIFICATION}{SEQUENCE}.
Authentication
- OAuth 2.0: OAuth2
Client credentials flow
| Security Scheme Type: | oauth2 |
|---|---|
| OAuth Flow (clientCredentials): | Scopes: |