Alert data

Abstract

Use this topic to find definitions for objects and fields used in the Grid API v2 /alert endpoints.

This topic contains definitions for objects and fields used in the Grid API v2 /alert endpoints.

GridAlertNotifyRq

Response data for an alert generated from an inquiry or Portfolio Monitoring batch. You receive this object when your system is configured for webhook push alerts from the /grid-alert/notify endpoint.

Field	Name	Type	Description
`rqUID`	Request UID	String	Unique identifier for the request. Used for tracking and correlation.
`msgRqHdr`	Message request header	Object	Header information for the request. Contains `MsgRqHdr` data.
`gridAlertKeys`	Grid alert keys	Object	The identifying key(s) for the alert. Contains `GridAlertKeys` data.
`gridAlertInfo`	Grid alert information	Object	Contains the full alert information. Contains `GridAlertInfo` data.

MsgRqHdr

Defines a request‑header structure containing authentication credentials and request‑context metadata.

Field	Name	Type	Description
`credentialsRqHdr`	Credentials request header	Object	One or more credential elements used to authenticate the calling application. Each entry includes a login name and subject password. Contains `CredentialsRqHdr` data.
`contextRqHdr`	Context request header	Object	Provides request‑level context, including client application identification, firm identifier, API interface version information, and other contextual metadata used during request processing. Contains `ContextRqHdr` data.

Field

Name

Type

Description

credentialsRqHdr

Credentials request header

Object

One or more credential elements used to authenticate the calling application. Each entry includes a login name and subject password.

Contains CredentialsRqHdr data.

contextRqHdr

Context request header

Object

Provides request‑level context, including client application identification, firm identifier, API interface version information, and other contextual metadata used during request processing.

Contains ContextRqHdr data.

CredentialsRqHdr

Defines the authentication credentials supplied in a request header and contains a list of SecTokenLogin entries.

Field	Name	Type	Description
`secTokenLogin`	Secure token login	Array	Each entry contains `loginName` and `subjectPswd` used to authenticate the Grid request.

ContextRqHdr

Supplies contextual metadata for a request. It identifies the calling application, the firm associated with the request, the interface version to apply, and any header overrides or interface‑level configuration flags.

Field	Name	Type	Description
`clientApp`	Client application	Object	Contains `ClientApp` data that identifies the client application making the request. Includes fields for organization name, application name, and version.
`firm`	Firm	Object	Contains `Firm` data that specifies the firm associated with the request. Contains fields for firm number and firm name.
`version`	Version	String	Indicates the interface version to ensure compatibility between client and service interface versions.
`hdrFields`	Header fields	Object	Contains `HdrFields` data for `LOAD_ONLY` requests.
`interface`	Interface definition	Object	Contains `Interface` data that specifies the interface name and version the client expects to use. Uses default value if omitted. Default value: `1.0` Example values: `XML`, `DOC`, `REF`, `XML_1_1`, and `ALL_1_1`.
`endpointStatisticsEnabled`	Endpoint statistics enabled	Boolean	When set to `true`, endpoint‑usage statistics are included for the request. Helps with monitoring usage thresholds or performance behavior.

GridAlertKeys

Key identifiers associated with an alert. You use this object when submitting or receiving alert‑related operations, where the key uniquely identifies an alert being transmitted.

Field	Name	Type	Description
`gridAlertId`	Grid alert ID	String	The unique identifier for a Grid alert. This value is required when referencing or notifying an alert in the API.

GridAlertInfo

Contains alert data such as inquiry info and alert details.

Field	Name	Type	Description
`reportPDF`	Report PDF	String	Base64-encoded PDF report associated with the alert.
`gridInquiryRec`	Grid inquiry record	Object	Inquiry details related to the alert. Contains `GridInquiryRec` data.
`alerts`	Alerts	Object	Alert entities and related data. Contains `Alerts` data.
`clientDecisioningNote`	Client decisioning note	Array	Notes added during client decisioning. Contains `ClientDecisioningNote` data.

GridInquiryRec

A single inquiry record inside an alert response.

Field	Name	Type	Description
`gridInquiryId`	Grid inquiry ID	String	Unique identifier for the inquiry associated with the alert.
`gridInquiryInfo`	Grid inquiry info	Object	Provides context from the original inquiry that produced the alert. Contains `GridInquiryInfo` data.
`gridInquiryStatus`	Grid inquiry status	Object	Current status of the inquiry. Contains GridInquiryStatus data.

Field

Name

Type

Description

gridInquiryId

Grid inquiry ID

String

Unique identifier for the inquiry associated with the alert.

gridInquiryInfo

Grid inquiry info

Object

Provides context from the original inquiry that produced the alert.

Contains GridInquiryInfo data.

gridInquiryStatus

Grid inquiry status

Object

Current status of the inquiry.

Contains GridInquiryStatus data.

GridInquiryInfo

Populated by Inquiry metadata that includes screening fields, submitted party data, portfolio monitoring flags, duplicate‑handling settings, and customer IDs.InquiryDto

Field	Name	Type	Description
`portfolioMonitoring`	Portfolio monitoring	Boolean	Indicates if portfolio monitoring is enabled for the inquiry. Default value: `false`.
`loadOnly`	Load only	Boolean	When set to `true`, the record is loaded into Portfolio Monitoring, but not searched. Default value: `false`
`globalSearch`	Global search	Boolean	When `true`, the search includes all geographies, overriding geography-related filter expressions, for example, country match. Default value: `false`.
`reporting`	Reporting ID	String	Client-defined reporting identifier. This identifier is stored on the inquiry and returned with responses, but is not used by Grid in any way. Example format: `REPORT456`.
`tracking`	Tracking ID	String	Client-defined tracking identifier. This identifier is stored on the inquiry and returned with responses, but is not used by Grid in any way. Example format: `TRACK123`
`portfolioMonitoringActionIfDuplicate`	Portfolio monitoring action if duplicate	String	Action if submitted inquiries are duplicates to Portfolio Monitoringinquiries. Possible values: `REPLACE`: All entries in your portfolio with matching tracking IDs will be replaced with the data in the inquiry. `APPEND`: The inquiry will be added to your portfolio along with other inquiries with the same tracking ID. `NONE`: The inquiry will not be added to your portfolio and nothing in your portfolio will be replaced or removed.
`searchActionIfDuplicate`	Search action if duplicate	String	Action for searching duplicate inquiries in Portfolio Monitoring. Possible values: `SEARCH`: Perform the search. `SEARCH_UNLESS_SEARCHED`: Perform the search unless a duplicate inquiry with a matching tracking ID has already been searched. `NONE`: Do not perform a search when a duplicate is detected.
`screeningType`	Screening type	String	Indicates the entity screening type to use for an inquiry. If not specified, the firm default value will be used. If there is no firm default value, an auto-classify screening type, `C`, is used. Possible values: `P` (Person), `O` (Organization), or `A` (All).
`screenedAsType`	Screened as type	String	The entity screening type that was actually used for an inquiry. This can be useful when the `C` `screeningType` is specified, to see what screening type was used based on the auto classification. Possible values: `P` (Person), `O` (Organization), or `A` (All).
`gridPersonPartyInfo`	Grid person party info	Object	Person-specific information used in inquiries. Contains `GridPersonPartyInfo` data.
`gridOrgPartyInfo`	Grid org party info	Object	Organization-specific information used in inquiries. Contains `GridOrgPartyInfo` data.
`gridUnknownPartyInfo`	Grid unknown party info	Object	Information used in inquiries for unknown party types. Contains `GridUnknownPartyInfo` data.
`note`	Note	String	Additional free-text notes for the inquiry.
`submissionMethodType`	Submission method type	String	Received in responses and indicates the submission method used for an inquiry. Possible values: `WEB`: Submitted via the web interface. `WS`: Submitted via web services (API integration). `SYSTEM`: Submitted by an internal system process. `PM`: Submitted for Portfolio Monitoring.

Alerts

Groups the alert details generated for an inquiry.

Field	Name	Type	Description
`alertDt`	Alert date	String	Date and time of an alert. The format is `date-time`.
`alertEntity`	Alert entity	Array	Collection of entity-level alert details. Contains `AlertEntity` data.
`nonReviewedAlertEntity`	Non-reviewed alert entity	Array	Represents entities not yet reviewed. Contains `NonReviewedAlertEntity` data.
`clientDecisionedAlertEntity`	Client decisioned alert entity	Array	Collection of entity-level alerts where a client decision exists. Contains `ClientDecisionedAlertEntity` data.
`alertIlistEntry`	Alert iList entry	Array	Collection of reviewed list‑entry alerts. Contains `AlertIlistEntry` data.
`clientDecisionedAlertIlistEntry`	Client decisioned iList entry	Array	Collection of list‑entry alerts with client decisions. Contains `ClientDecisionedAlertIlistEntry` data.
`nonReviewedAlertIlistEntry`	Non-reviewed iList entry	Array	Collection of non‑reviewed list‑entry alerts. Contains `NonReviewedAlertIlistEntry` data.
`portfolioMonitoringAlert`	Portfolio Monitoring alert indicator	Boolean	When `true`, this indicates that an alert was generated by Portfolio Monitoring. Default value: `false`.

AlertEntity

Provides information about entities that trigger alerts, including identifying information, addresses, events, source metadata, and risk‑related data.

Field	Name	Type	Description
`matchScore`	Match score	Integer	Numeric score representing the entity match strength. Range: 0-100
`riskScore`	Risk score	Integer	Numeric risk value assigned to an entity. Range: 0 ≤ value < 100
`cvip`	CVIP	String	CVIP classification for an entity.
`entityId`	Entity ID	Integer	The Grid‑assigned entity ID.
`entityTyp`	Entity type	String	Indicates the entity screening type. Possible values: `P` (Person) or `O` (Organization)
`entityName`	Entity name	String	Name of an entity.
`source`	Source	Object	Metadata describing an information source for an alert match. Contains `Source` data.
`event`	Event	Array	Events related to an entity. Contains `Event` data.
`postAddr`	Postal address	Array	Address details associated with an entity. Contains `PostAddr` data.
`birthDt`	Birth date	Array	Birth date in `YYYY‑MM‑DD` format. Multiple values may be provided.
`attribute`	Attributes	Array	Additional attributes for an entity. Contains `Attribute` data.
`alertNote`	Alert note	String	Text note attached to the entity within an alert.
`sysId`	System ID	String	The system‑assigned identifier for the entity.
`rdcURL`	RDC URL	String	URL pointing to the Grid record associated with an entity.
`alias`	Aliases	Array	Alternate names for an entity. Contains `Alias` data.
`sources`	Sources	Object	Source list for an entity. Contains `Sources` data.
`fullPositions`	Full positions	Object	List of roles or positions tied to an entity. Contains `FullPositions` data.
`pepTypes`	PEP types	Object	Politically exposed person (PEP) classifications for an entity. Contains `PepTypes` data.
`rels`	Relationships	Object	Relationship data linking the entity to other individuals or organizations. Contains `Rels` data.
`alertConfidence`	Alert confidence	Number	A numeric indicator of the system’s confidence in the relevance of the matched entity to the inquiry.

Sources

A list of sources from which information about an alerted entity was obtained. Contains an array of source objects with the following fields.

Field	Name	Type	Description
`entityDt`	Entity date	String	The event or entity date associated with this source. Example format: `YYYY‑MM‑DD`
`format`	Format	String	The content format, for example, text, document, media.
`headline`	Headline	String	The headline or title associated with the source content.
`publicationSource`	Publication source	String	The originating publication or media outlet.
`publisher`	Publisher	String	The entity that published the source information.
`sourceKy`	Source key	String	A unique key or identifier assigned to this source.
`sourceName`	Source name	String	The name of the information source.
`sourceURL`	Source URL	String	The URL where the source content originates.

Event

A single event record associated with an entity in an alert response.

Field	Name	Type	Description
`category`	Category	Object	Identifies an event’s main category, for example, sanction, enforcement action, or adverse media. Contains `Category` data.
`eventDesc`	Event description	String	Text describing an event.
`eventDt`	Event date	String	The date of an event in `YYYY‑MM‑DD` format.
`subCategory`	Sub‑category	Object	Additional classification that further qualifies an event type. Contains `Category` data.
`source`	Source	Object	Information about the source reporting an event. Contains `Source` data.

PostAddr

Captures a postal address associated with an entity in an alert response, including location details and the effective date range for which the address applies.

Field	Name	Type	Description
`locatorTyp`	Locator type	String	The type of address locator used, for example, a structural or descriptive reference.
`addr1`	Address line 1	String	Primary street address line.
`addr2`	Address line 2	String	Secondary street address line (optional).
`city`	City	String	City of the address.
`stateProv`	State or province	String	State or provincial region.
`postalCode`	Postal code	String	Postal or ZIP code.
`countryCode`	Country code	String	Two-letter country code associated with the address. Format: ISO 3166-1 alpha-2
`fromDt`	From date	String	The date when this address became effective. Example format: `YYYY‑MM‑DD`
`toDt`	To date	String	The date when this address became no longer effective. Example format: `YYYY‑MM‑DD`

Attribute

Represents a single attribute associated with a person, organization, or alert entity.

Field	Name	Type	Description
`attCode`	Attribute code	String	Code that identifies the kind of attribute. See Grid risk attribute codes for more information.Grid risk attribute codes
`attDesc`	Attribute description	String	Human‑readable description of the attribute, when provided.
`attVal`	Attribute value	String	The value associated with the attribute code. For example, an ID number, deceased date, or source link.

Field

Name

Type

Description

attCode

Attribute code

String

Code that identifies the kind of attribute.

See Grid risk attribute codes for more information.Grid risk attribute codes

attDesc

Attribute description

String

Human‑readable description of the attribute, when provided.

attVal

Attribute value

String

The value associated with the attribute code. For example, an ID number, deceased date, or source link.

Alias

Identifies an alternative name used by an entity and classifies the alias type.

Field	Name	Type	Description
`aliasTyp`	Alias type	String	Type/category of alias name, for example, alternate spellings or alternate language forms.
`aliasName`	Alias name	String	The alternate name itself.
`bestMatch`	Best match flag	Boolean	Indicates whether this alias represents the best or most relevant alias match. Default value: `false`

Field

Name

Type

Description

aliasTyp

Alias type

String

Type/category of alias name, for example, alternate spellings or alternate language forms.

aliasName

Alias name

String

The alternate name itself.

bestMatch

Best match flag

Boolean

Indicates whether this alias represents the best or most relevant alias match.

Default value: false

FullPositions

The complete available set of positions, roles, titles, statuses, or capacities records associated with an entity. Contains an array of fullPosition data with the following fields.

Field	Name	Type	Description
`fromDate`	Start date	String	The date when the position began. Example format: `YYYY-MM-DD`.
`position`	Position name	String	The title or name of the position.
`toDate`	End date	String	The date when the position ended. If omitted, the position may still be active. Example format: `YYYY‑MM‑DD`.

Field

Name

Type

Description

fromDate

Start date

String

The date when the position began.

Example format: YYYY-MM-DD.

position

Position name

String

The title or name of the position.

toDate

End date

String

The date when the position ended. If omitted, the position may still be active.

Example format: YYYY‑MM‑DD.

PepTypes

A list of PEP classifications associated with an entity. Contains an array of pepType objects with the following fields.

Field	Name	Type	Description
`type`	PEP type	String	The category of PEP role assigned to the entity.
`level`	PEP level	Integer	The hierarchical level associated with the PEP role.
`position`	Position title	String	The title or position linked to the PEP designation.
`fromDate`	Role start date	String	The date when the entity began holding the PEP role. Example format: `YYYY‑MM‑DD`.
`toDate`	Role end date	String	The date when the entity stopped holding the PEP role. Example format: `YYYY‑MM‑DD`.

Rels

The collection of relationships associated with an entity. Contains an array of rel objects with the following fields.

Field	Name	Type	Description
`relDir`	Relationship direction	String	Indicates the direction of the relationship relative to the primary entity, for example, whether the related entity is upstream, downstream, or otherwise directionally linked.
`relTyp`	Relationship type	String	The category or class of the relationship. Indicates how the entities are connected.
`sysId`	Related entity system ID	String	A system‑assigned identifier used to associate the related entity with additional details.
`entityName`	Related entity name	String	A human‑readable name for the related entity referenced by `sysId`.

NonReviewedAlertEntity

An alert entity that has been matched to an inquiry but has not yet been reviewed by Analyst Review or by Client Alert Decisioning. This object uses the same structure as AlertEntity.

ClientDecisionedAlertEntity

An entity match that has been reviewed and decisioned in Client Alert Decisioning. This object uses the same structure as AlertEntity with an additional clientDecisioningReason field.

Field	Name	Type	Description
`clientDecisioningReason`	Client decision reason	Object	Details documenting a particular decision reason for an entity. Contains `ClientDecisioningReason` data.

Field

Name

Type

Description

clientDecisioningReason

Client decision reason

Object

Details documenting a particular decision reason for an entity.

Contains ClientDecisioningReason data.

ClientDecisioningReason

The client‑provided explanation for why a particular alert or entity match was decisioned in a certain way.

Field	Name	Type	Description
`reasonCode`	Decision reason code	String	A structured code representing the client’s selected decision reason.
`reasonDescription`	Decision reason description	String	A human‑readable explanation of the decision reason.

AlertIlistEntry

Represents an iList entry that appears within an alert response.

Field	Name	Type	Description
`matchScore`	Match score	Integer	Match score for the iList entry. Indicates the strength of match between an inquiry and an iList record.
`personIlistInfo`	Person iList information	Object	Person‑level information for a matched iList entry. Contains `PersonIlistInfo` data.
`orgIlistInfo`	Organization iList information	Object	Organization‑level information for a matched iList entry. Contains `OrgIlistInfo` data.
`countryIlistInfo`	Country iList information	Object	Country‑level iList information. Contains `CountryIlistInfo` data.

ClientDecisionedAlertIlistEntry

Represents an iList entity match that has been reviewed and decisioned in Client Alert Decisioning. This object uses the same structure as AlertIlistEntry with an additional clientDecisioningReason field.

Field	Name	Type	Description
`clientDecisioningReason`	Client decisioning reason	Object	The client‑assigned reason explaining a decision for an iList alert entry. Contains `ClientDecisioningReason` data.

Field

Name

Type

Description

clientDecisioningReason

Client decisioning reason

Object

The client‑assigned reason explaining a decision for an iList alert entry.

Contains ClientDecisioningReason data.

NonReviewedAlertIlistEntry

Represents an iList alert match that has not yet been reviewed and contains only the core match details. This object uses the same structure as AlertIlistEntry.

ClientDecisioningNote

A note that is attached to an alert during the client decisioning process.

Field	Name	Type	Description
`createdDateTime`	Created date and time	String	Timestamp indicating when a note was created. Format follows the service’s standard `date-time` representation.
`createdUser`	Created by	String	Name or identifier of the user who created the note.
`note`	Decision note	String	The text of the note explaining the decision.

Field

Name

Type

Description

createdDateTime

Created date and time

String

Timestamp indicating when a note was created.

Format follows the service’s standard date-time representation.

createdUser

Created by

String

Name or identifier of the user who created the note.

note

Decision note

String

The text of the note explaining the decision.

ResponseListAlert

The standard response wrapper for alerts, containing the alert data and the response‑level status information.

Field	Name	Type	Description
`data`	Alert list	Array	The collection of alerts in a response. Each alert contains `Alert` data.
`status`	Response status	Object	Metadata about the response. Contains `ResponseStatus` data.

Field

Name

Type

Description

data

Alert list

Array

The collection of alerts in a response.

Each alert contains Alert data.

status

Response status

Object

Metadata about the response.

Contains ResponseStatus data.

Alert

A single Grid alert resource received when retrieving alerts for inquiries or batches.

Field	Name	Type	Description
`id`	Alert ID	String	Unique identifier for an alert. Use this value to reference or correlate an alert in your systems.
`info`	Alert info	Object	Detailed information for an alert. Contains `GridAlertInfo` data.
`status`	Alert status	Object	Represents the processing status of an alert. Contains `GridAlertStatus` data.

Field

Name

Type

Description

id

Alert ID

String

Unique identifier for an alert. Use this value to reference or correlate an alert in your systems.

info

Alert info

Object

Detailed information for an alert.

Contains GridAlertInfo data.

status

Alert status

Object

Represents the processing status of an alert.

Contains GridAlertStatus data.

GridAlertStatus

The processing state of an alert.

Field	Name	Type	Description
`gridAlertStatusCode`	Alert status code	String	Status of the alert. Possible values: `COMPLETE`, `PROCESSING`.
`statusDesc`	Status description	String	Human-readable description of the alert status.
`effDt`	Effective date	String	Date and time when the status became effective (ISO 8601 format).

Field

Name

Type

Description

gridAlertStatusCode

Alert status code

String

Status of the alert.

Possible values: COMPLETE, PROCESSING.

statusDesc

Status description

String

Human-readable description of the alert status.

effDt

Effective date

String

Date and time when the status became effective (ISO 8601 format).

ResponseStatus

Provides the high‑level status details for a response, including the status code, severity type, and a human‑readable description.

Field	Name	Type	Description
`code`	Status code	Integer	Numeric code representing the response status.
`type`	Status type	String	Type of status. Possible values: `ERROR`, `WARNING`, `INFO`.
`description`	Status description	String	Human-readable description of the response status.
`additionalResponseStatuses`	Additional response statuses	Array	Additional status details. Contains `AdditionalResponseStatus` data.

AdditionalResponseStatus

Provides supplemental status details typically used to return multiple warnings, informational messages, or secondary error conditions as part of the same response.

Field	Name	Type	Description
`type`	Type	String	Type of additional status. Possible values: `ERROR`, `WARNING`, `INFO`.
`description`	Description	String	Description of the additional status.
`code`	Code	Integer	Numeric code for the additional status.

Field

Name

Type

Description

type

Type

String

Type of additional status.

Possible values: ERROR, WARNING, INFO.

description

Description

String

Description of the additional status.

code

Code

Integer

Numeric code for the additional status.

AlertPagination

Provides pagination details for a paginated alert response.

Field	Name	Type	Description
`pageNumber`	Page number	Integer	The current page number being returned.
`totalPages`	Total pages	Integer	The total number of result pages available for the query.
`pageSize`	Page size	Integer	The number of alert records included in each page.
`totalItems`	Total items	Integer	The total number of alert records matching the request criteria.

GridAlertRec

A single alert record returned for an inquiry.

Field	Name	Type	Description
`gridAlertId`	Grid alert ID	String	Unique identifier for the alert record.
`gridAlertInfo`	Grid alert info	Object	Detailed information about the alert. Contains `GridAlertInfo` data.
`gridAlertStatus`	Grid alert status	Object	Represents the current status of the alert. Contains `GridAlertStatus` data.

Field

Name

Type

Description

gridAlertId

Grid alert ID

String

Unique identifier for the alert record.

gridAlertInfo

Grid alert info

Object

Detailed information about the alert.

Contains GridAlertInfo data.

gridAlertStatus

Grid alert status

Object

Represents the current status of the alert.

Contains GridAlertStatus data.

Additional information

In this section:

Alert data

GridAlertNotifyRq

MsgRqHdr

CredentialsRqHdr

ContextRqHdr

GridAlertKeys

GridAlertInfo

GridInquiryRec

GridInquiryInfo

Alerts

AlertEntity

Sources

Event

PostAddr

Attribute

Alias

FullPositions

PepTypes

Rels

NonReviewedAlertEntity

ClientDecisionedAlertEntity

ClientDecisioningReason

AlertIlistEntry

ClientDecisionedAlertIlistEntry

NonReviewedAlertIlistEntry

ClientDecisioningNote

ResponseListAlert

Alert

GridAlertStatus

ResponseStatus

AdditionalResponseStatus

AlertPagination

GridAlertRec

Additional information

Search results