v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Alerts & Risks

Get the notes for a screening risk

Get the notes for a screening risk

get/v2/entity-screening/risks/{risk_identifier}/notes

Path parameters

risk_identifierstring uuid required

The unique risk identifier

Query parameters

related_notesboolean

If true, retrieves all notes attached to the profile associated with the requested risk

page_numberinteger

One-based page index (1..N)

page_sizeinteger

The size of the page to be returned

sortstring[]

Sort notes by created_at. Prefix with '-' for descending order (e.g. -created_at), or omit the prefix for ascending order (e.g. created_at).

Response

OK

firststring nullable

URL to fetch the first page of items

nextstring nullable

URL to fetch the next page of items

prevstring nullable

URL to fetch the previous page of items

selfstring nullable

URL to fetch the current page of items

total_countinteger nullable

Total number of notes across all pages