Skip to main content
GET
Get risk profile

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1

Path Parameters

id
string<uuid>
required

Risk-profile ID

Response

Success

catchall
object

Baseline decision for every alert level, applied to any alert not matched by a rule.

created_at
string<date-time>

When the risk profile was created.

Example:

"2026-05-16T10:30:00Z"

id
string

Unique identifier of the risk profile.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

is_default
boolean

Whether this profile is the organization's active default, applied to screening decisions.

Example:

true

name
string

Human-readable name of the risk profile.

Example:

"default"

object
string

Object type discriminator; always "risk_profile".

Example:

"risk_profile"

rules
object[]

Category rules evaluated before the catch-all.

updated_at
string<date-time>

When the risk profile was last updated.

Example:

"2026-05-16T10:30:00Z"