Skip to content
Prefactor Docs

Delete a risk profile

DELETE
/api/v1/risk_profile/{risk_profile_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
risk_profile_id
required
RiskProfile_Id

A valid risk profile ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Request Body

Section titled “Request Body ”
One of:

Optional idempotency key for ensuring request idempotency

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
RiskProfile_Details
object
description
One of:

Risk profile description

string
id
RiskProfile_Id

A valid risk profile ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
inserted_at

When the risk profile was created

string format: date-time
name

Risk profile name

string
Example
High Risk
ruleset
RiskProfile_Ruleset
object
action_multipliers
required
RiskProfile_Ruleset_ActionMultipliers
object
create_data
required
One of:

Multiplier when the span creates data (null or 0 = N/A)

number
destroy_data
required
One of:

Multiplier when the span destroys data (null or 0 = N/A)

number
external_communication
required
One of:

Multiplier for external communication actions (null or 0 = N/A)

number
financial_transactions
required
One of:

Multiplier for financial transaction actions (null or 0 = N/A)

number
read_data
required
One of:

Multiplier when the span reads data (null or 0 = N/A)

number
update_data
required
One of:

Multiplier when the span updates data (null or 0 = N/A)

number
category_weights
required
RiskProfile_Ruleset_CategoryWeights

Weights per sensitive data category; each field is a positive integer or null (null or 0 = N/A)

object
authentication_and_secrets
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
behavioural_and_inferred
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
contact_information
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
criminal_justice
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
financial_information
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_biometric_for_identification
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_genetic_data
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_political_opinions
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_racial_or_ethnic_origin
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_religious_or_philosophical_beliefs
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_sex_life_or_sexual_orientation
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
gdpr_trade_union_membership
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
health_and_medical
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
location_and_tracking
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
minors_data
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
organisational_confidential
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
personal_identifiers
required
One of:

Positive integer weight for this category, or null / 0 if the profile does not apply to it

integer
thresholds
required
RiskProfile_Ruleset_Thresholds
object
critical
required

Scores above this map to critical risk

integer
high
required

Scores above this map to at least high risk

integer
medium
required

Scores above this (after medium) map to at least medium risk

integer
type

Type of resource (always ‘risk_profile’)

string
Allowed values: risk_profile
Example
risk_profile
updated_at

When the risk profile was last updated

string format: date-time
status
string
Allowed values: success
Example
success

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value idempotency_key_already_used
Example
bad_request
message
string
status
string
Allowed values: error
Example
error