Skip to main content
GET
Get Portfolio Item Notifications

Authorizations

X-API-Key
string
header
required

Path Parameters

item_id
string<uuid>
required

The unique identifier of the portfolio item to get notifications for.

Examples:

"412a49b5-7466-426b-bf1e-081b00b54576"

"9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5"

Query Parameters

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Response

Response

message
StructuredText (v1) · object
required

The message of the notification.

notifiable_attribute
enum<string>
required

The attribute that triggered the notification.

Available options:
registration_health,
new_registrations,
addresses,
officers,
alternative_names,
kyb_score,
risk_score,
identity_network,
pep,
ofac,
liens,
litigations,
bankruptcies,
website_analysis