Skip to content
Docs

Enforcement API

Before a protected action commits, your integration calls SentinelX and keeps a hash-bound receipt of the decision.

Path to use the API: Request API access, then follow onboarding. Or book a demo for an assisted rollout. Samples below are illustrative.

1. Get started

  1. Request API access. Submit at /register. Keys are issued during onboarding, not instantly from the form. Prefer an assisted rollout? Book a demo.
  2. Call POST /enforce before the action commits.
    curl · illustrative
    # Illustrative: shape of a request, not a working sample
    # $SENTINELX_ENDPOINT: an HTTPS endpoint issued at onboarding
    curl -sS "$SENTINELX_ENDPOINT" \
      -H "Authorization: Bearer <your API key>" \
      -H "Content-Type: application/json" \
      -d '{
        "action": "wire.transfer",
        "subject": "acct_9f2",
        "context": { "amount": 250000, "currency": "USD" }
      }'
  3. Keep the receipt. Every decision produces a hash-bound receipt. Signing custody is in progress. Receipts are evidence, not permission.

2. Authentication

Send Authorization: Bearer <key> on every request.

  • Keys are issued and scoped during onboarding.
  • Rotation: request a replacement key; the previous key is revoked on confirmation.

3. POST /enforce

Request

JSON body · illustrative
// Illustrative
{
  "action": "string",   // the consequential action about to happen
  "subject": "string",  // who or what it acts on
  "context": { }        // the facts your app already has
}

Response

JSON · illustrative
// Illustrative
{
  "verdict": "admissible" | "inadmissible",
  "receipt": {
    "receipt_hash": "string",
    "request_hash": "string"
  }
}

Errors

CodeMeaningRetry
401Missing or invalid Bearer token.Do not retry until the key is fixed. Rotate if leaked.
403Key valid but not scoped for this action or environment.Do not retry the same call. Request the correct scope through onboarding.
422Request body invalid.Fix the request. Do not blind-retry.
429Rate limit or capacity exceeded for this key.Back off with jitter. Limits are set per tenant.
5xxService error.Retry with backoff. Until a verdict arrives, your integration treats the action as refused.

4. Failing closed

Failing closed is a property of where you place the call. Your integration must treat a missing verdict, including a timeout or an error, as a refusal, and must not commit the action.

SentinelX does not replace IAM. It sits before execution.

5. Receipts

Every decision produces a hash-bound receipt. Signing custody is in progress. Receipts are evidence, not permission. Receipt signing with published verification key is reviewed, not deployed.

Status

Status of SentinelX capabilities
In productionReviewed, not deployedDesigned
  • Decision API at enforce.sentinelx.ai/v2/enforcePlaceholder: pending counsel OK
  • [N] catalogued invariantsPlaceholder: count unverified
  • Observe and enforce modes
  • Hash-bound receipts (signing custody in progress)
  • INADMISSIBLE returns HTTP 403 with a structured body
  • Receipt signing with published verification key
  • Attested by: caller / platform / owner
  • Transparency log for receipts
  • Customer-held signing keys

6. Rate limits and capacity

Limits are set per tenant during onboarding.

7. Client libraries

No client libraries are published yet. Call the HTTP route directly. Any package name you see in a sample is illustrative.

8. Versioning

Additive fields may appear. Required fields and the verdict values (admissible / inadmissible) will not silently change. Breaking changes ship with notice to active tenants.