Fidera
Docs
Browse documentation
Check policy

Update Check Policy

put/v1/check_policy

Update Check Policy

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Request body

JSON · required

aml_match_policy
AmlMatchPolicy

No additional field description.

blocked_countries
string[]

No additional field description.

default_datasets
string[]required

No additional field description.

device_velocity_threshold
integer

No additional field description.

fatf_black_handling
"flag" | "block"

No additional field description.

fatf_grey_handling
"ignore" | "flag"

No additional field description.

four_eyes_required
boolean

No additional field description.

vpn_policy
"allow" | "review" | "block"

No additional field description.

Example request

cURL
curl --request PUT \
  --url 'https://api.fideralabs.com/v1/check_policy' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "aml_match_policy": {
    "algorithm": "logic-v2",
    "dataset_thresholds": {},
    "exclude_sources": [
      "string"
    ],
    "fail_threshold": 0.85,
    "feature_weights": {},
    "include_sources": [
      "string"
    ],
    "include_weak_aliases": false,
    "review_threshold": 0.6,
    "use_case_thresholds": {}
  },
  "blocked_countries": [
    "string"
  ],
  "default_datasets": [
    "string"
  ],
  "device_velocity_threshold": 3,
  "fatf_black_handling": "flag",
  "fatf_grey_handling": "ignore",
  "four_eyes_required": false,
  "vpn_policy": "review"
}'

Responses

200Successful Response
aml_match_policy
AmlMatchPolicyrequired

No additional field description.

blocked_countries
string[]required

No additional field description.

default_datasets
string[]required

No additional field description.

device_velocity_threshold
integerrequired

No additional field description.

fatf_black_handling
"flag" | "block"required

No additional field description.

fatf_grey_handling
"ignore" | "flag"required

No additional field description.

four_eyes_required
booleanrequired

No additional field description.

policy_version
stringrequired

No additional field description.

vpn_policy
"allow" | "review" | "block"required

No additional field description.

application/json
{
  "aml_match_policy": {
    "algorithm": "logic-v2",
    "dataset_thresholds": {},
    "exclude_sources": [
      "string"
    ],
    "fail_threshold": 0.85,
    "feature_weights": {},
    "include_sources": [
      "string"
    ],
    "include_weak_aliases": false,
    "review_threshold": 0.6,
    "use_case_thresholds": {}
  },
  "blocked_countries": [
    "string"
  ],
  "default_datasets": [
    "string"
  ],
  "device_velocity_threshold": 0,
  "fatf_black_handling": "flag",
  "fatf_grey_handling": "ignore",
  "four_eyes_required": true,
  "policy_version": "string",
  "vpn_policy": "allow"
}
422Validation Error
detail
ValidationError[]

No additional field description.

Operation ID

update_check_policy_v1_check_policy_put