Rule Instance - Update | Flagright

curl -X POST https://sandbox.api.flagright.com/management/rule-instances/ruleInstanceId \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "string",
  "type": "TRANSACTION",
  "ruleId": "string",
  "checksFor": [
    "string"
  ],
  "runCount": 1.1,
  "hitCount": 1,
  "createdAt": 1.1,
  "updatedAt": 1.1,
  "alertCreationOnHit": true,
  "filters": {},
  "parameters": {},
  "ruleNameAlias": "string",
  "riskLevelParameters": {
    "VERY_HIGH": {},
    "HIGH": {},
    "MEDIUM": {},
    "LOW": {},
    "VERY_LOW": {}
  },
  "action": "ALLOW",
  "riskLevelActions": {
    "VERY_HIGH": "ALLOW",
    "HIGH": "ALLOW",
    "MEDIUM": "ALLOW",
    "LOW": "ALLOW",
    "VERY_LOW": "ALLOW"
  },
  "triggersOnHit": {
    "usersToCheck": "ALL",
    "userStateDetails": {
      "reason": "string",
      "state": "UNACCEPTABLE",
      "description": "string"
    },
    "kycStatusDetails": {
      "reason": "string",
      "status": "SUCCESSFUL",
      "description": "string"
    },
    "pepStatus": {
      "isPepHit": true,
      "pepCountry": "AF",
      "pepRank": "LEVEL_1",
      "category": "string"
    },
    "sanctionsStatus": true,
    "adverseMediaStatus": true
  },
  "riskLevelsTriggersOnHit": {
    "VERY_HIGH": {
      "usersToCheck": "ALL",
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE",
        "description": "string"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL",
        "description": "string"
      },
      "pepStatus": {
        "isPepHit": true,
        "pepCountry": "AF",
        "pepRank": "LEVEL_1",
        "category": "string"
      },
      "sanctionsStatus": true,
      "adverseMediaStatus": true
    },
    "HIGH": {
      "usersToCheck": "ALL",
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE",
        "description": "string"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL",
        "description": "string"
      },
      "pepStatus": {
        "isPepHit": true,
        "pepCountry": "AF",
        "pepRank": "LEVEL_1",
        "category": "string"
      },
      "sanctionsStatus": true,
      "adverseMediaStatus": true
    },
    "MEDIUM": {
      "usersToCheck": "ALL",
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE",
        "description": "string"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL",
        "description": "string"
      },
      "pepStatus": {
        "isPepHit": true,
        "pepCountry": "AF",
        "pepRank": "LEVEL_1",
        "category": "string"
      },
      "sanctionsStatus": true,
      "adverseMediaStatus": true
    },
    "LOW": {
      "usersToCheck": "ALL",
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE",
        "description": "string"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL",
        "description": "string"
      },
      "pepStatus": {
        "isPepHit": true,
        "pepCountry": "AF",
        "pepRank": "LEVEL_1",
        "category": "string"
      },
      "sanctionsStatus": true,
      "adverseMediaStatus": true
    },
    "VERY_LOW": {
      "usersToCheck": "ALL",
      "userStateDetails": {
        "reason": "string",
        "state": "UNACCEPTABLE",
        "description": "string"
      },
      "kycStatusDetails": {
        "reason": "string",
        "status": "SUCCESSFUL",
        "description": "string"
      },
      "pepStatus": {
        "isPepHit": true,
        "pepCountry": "AF",
        "pepRank": "LEVEL_1",
        "category": "string"
      },
      "sanctionsStatus": true,
      "adverseMediaStatus": true
    }
  },
  "status": "ACTIVE",
  "casePriority": "P1"
}

Update Rule Instance

Created rule instances can be idempotently updated with the POST /rule-instances/{ruleInstanceId}.

Authentication

x-api-keystring

API keys are used to authenticate the requests.

Path parameters

ruleInstanceIdstringRequired

Request

This endpoint expects an object.

ruleIdstringOptional

alertCreationOnHitbooleanOptional

filtersobjectOptional

Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.

parametersobjectOptional

ruleNameAliasstringOptional

riskLevelParametersobjectOptional

actionenumOptional

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskLevelActionsobjectOptional

triggersOnHitobjectOptional

riskLevelsTriggersOnHitobjectOptional

statusenumOptional

Allowed values:

casePriorityenumOptional

Allowed values:

Response

idstring

typeenum

ruleIdstring

checksForlist of strings

runCountdouble

hitCountinteger

createdAtdouble

updatedAtdouble

alertCreationOnHitboolean

filtersobject

Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.

parametersobject

ruleNameAliasstring

riskLevelParametersobject

actionenum

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskLevelActionsobject

triggersOnHitobject

riskLevelsTriggersOnHitobject

statusenum

Allowed values:

casePriorityenum

Allowed values:

Errors

400

Bad Request Error

404

Not Found Error