Rule - Get

Retrieve a Rule

GET /rules/{ruleId} endpoint returns a rule template supported by flagright.

get/rules/{ruleId}

Request

  • Base URL: https://sandbox.api.flagright.com/management
  • URL: https://sandbox.api.flagright.com/management/rules/{ruleId}
  • Auth: API key in header x-api-key

Path parameters

ruleIdstring required

Response

OK

idstring required
type'TRANSACTION' | 'USER' | 'USER_ONGOING_SCREENING' | 'TRANSACTION_SCREENING' | 'CONSUMER_USER_SCREENING' | 'BUSINESS_USER_SCREENING' | 'CRM_USER' | 'CRM_TICKET' required
namestring required
typesstring[] required
descriptionstring required
parametersSchemaRuleParametersSchema
defaultParametersRuleDefaultParameters required
defaultAction'ALLOW' | 'FLAG' | 'BLOCK' | 'SUSPEND' required

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

labelsRuleLabels[] required
defaultCasePriority'P1' | 'P2' | 'P3' | 'P4' required
defaultNature'AML' | 'FRAUD' | 'CTF' | 'SCREENING' required
checksForstring[] required
typologiesstring[] required
sampleUseCasesstring required

Changes

No recorded changes to this operation across all 1 revision of this API.