Skip to content
Steward Developers
Back to Steward

Update risk score configuration

PATCH
/api/v1/account/{accountId}/risk-settings

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
accountId
required
string

Request Body required

Section titled “Request Body required ”
object
factors

Risk factors with their options and weights

Array<object>
object
name
required

Name of the risk factor (section)

string
Allowed values: JURISDICTION OWNERSHIP INDUSTRY ENTITY_AGE LEGAL_ENTITY_TYPE PEP WATCHLIST SANCTIONS ADVERSE_MEDIA REGULATED SOURCE_OF_WEALTH
Example
OWNERSHIP
options
required

Options within this risk factor

Array<object>
object
name
required

Name of the risk factor option. Can be a RiskFactorOptionName enum value or a custom string.

string
Allowed values: JURISDICTION_VERY_LOW JURISDICTION_LOW JURISDICTION_MEDIUM JURISDICTION_MEDIUM_HIGH JURISDICTION_HIGH JURISDICTION_PROHIBITED OWNERSHIP_SIMPLE OWNERSHIP_LAYERED OWNERSHIP_COMPLEX gambling lottery adultServices cryptocurrency paydayLending moneyServices nonBankFinance oil gas mining defenceAerospace pharmaceuticals healthcare realEstate technology banking investment military preciousMetals tobacco other ENTITY_AGE_LESS_THAN_1_YEAR ENTITY_AGE_1_TO_3_YEARS ENTITY_AGE_3_PLUS_YEARS LEGAL_ENTITY_TYPE_LIMITED_COMPANY LEGAL_ENTITY_TYPE_TRUST LEGAL_ENTITY_TYPE_FOUNDATION LEGAL_ENTITY_TYPE_PARTNERSHIP LEGAL_ENTITY_TYPE_FUNDS_VEHICLE LEGAL_ENTITY_TYPE_OTHER SCREENING_ADVERSE_MEDIA_DETECTED SCREENING_PEP_DETECTED SCREENING_SANCTIONS_DETECTED SCREENING_WATCHLIST_DETECTED REGULATED_VERY_LOW_RISK REGULATED_LOW_RISK REGULATED_MEDIUM_LOW_RISK REGULATED_MEDIUM_HIGH_RISK REGULATED_HIGH_RISK REGULATED_PROHIBITED_RISK
score
required

Score for the risk factor option

number
Example
10
group

Group the option belongs to

string
nullable
Example
Ownership Risk
weight
required

Weight percentage for the risk factor

number
Example
80
metadata

Additional metadata for the factor

object
Example
[]
screeningTaxonomy
object
sources
required
Array<object>
object
sourceType
required
string
Example
ADVERSE_MEDIA
tiers
required
Array<object>
object
label
required
string
Example
Tier 1
weight
required
number
Example
10
description

Editable explanatory text shown on the (i) hover for this tier

string
nullable
categories
required
Array<object>
object
label
required
string
Example
Narcotics
description

Editable explanatory text shown on the (i) hover for this category

string
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Risk score settings updated

object
factors
required

Risk factors with their options and weights

Array<object>
object
name
required

Name of the risk factor (section)

string
Allowed values: JURISDICTION OWNERSHIP INDUSTRY ENTITY_AGE LEGAL_ENTITY_TYPE PEP WATCHLIST SANCTIONS ADVERSE_MEDIA REGULATED SOURCE_OF_WEALTH
Example
OWNERSHIP
options
required

Options within this risk factor

Array<object>
object
name
required

Name of the risk factor option. Can be a RiskFactorOptionName enum value or a custom string.

string
Allowed values: JURISDICTION_VERY_LOW JURISDICTION_LOW JURISDICTION_MEDIUM JURISDICTION_MEDIUM_HIGH JURISDICTION_HIGH JURISDICTION_PROHIBITED OWNERSHIP_SIMPLE OWNERSHIP_LAYERED OWNERSHIP_COMPLEX gambling lottery adultServices cryptocurrency paydayLending moneyServices nonBankFinance oil gas mining defenceAerospace pharmaceuticals healthcare realEstate technology banking investment military preciousMetals tobacco other ENTITY_AGE_LESS_THAN_1_YEAR ENTITY_AGE_1_TO_3_YEARS ENTITY_AGE_3_PLUS_YEARS LEGAL_ENTITY_TYPE_LIMITED_COMPANY LEGAL_ENTITY_TYPE_TRUST LEGAL_ENTITY_TYPE_FOUNDATION LEGAL_ENTITY_TYPE_PARTNERSHIP LEGAL_ENTITY_TYPE_FUNDS_VEHICLE LEGAL_ENTITY_TYPE_OTHER SCREENING_ADVERSE_MEDIA_DETECTED SCREENING_PEP_DETECTED SCREENING_SANCTIONS_DETECTED SCREENING_WATCHLIST_DETECTED REGULATED_VERY_LOW_RISK REGULATED_LOW_RISK REGULATED_MEDIUM_LOW_RISK REGULATED_MEDIUM_HIGH_RISK REGULATED_HIGH_RISK REGULATED_PROHIBITED_RISK
score
required

Score for the risk factor option

number
Example
10
group

Group the option belongs to

string
nullable
Example
Ownership Risk
weight
required

Weight percentage for the risk factor

number
Example
80
metadata

Additional metadata for the factor

object
Example
[]
screeningTaxonomy
object
sources
required
Array<object>
object
sourceType
required
string
Example
ADVERSE_MEDIA
tiers
required
Array<object>
object
label
required
string
Example
Tier 1
weight
required
number
Example
10
description

Editable explanatory text shown on the (i) hover for this tier

string
nullable
categories
required
Array<object>
object
label
required
string
Example
Narcotics
description

Editable explanatory text shown on the (i) hover for this category

string
nullable
Example
{
  "factors": [],
  "screeningTaxonomy": {
    "sources": []
  }
}