iList data

Abstract

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

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

IlistEntryRequest

A request object used to retrieve iList entry details in bulk.

Field	Name	Type	Description
`sysIds`	Entry system IDs	Array	Collection of iList entry system IDs to retrieve. Each ID represents an iList entry.

Field

Name

Type

Description

sysIds

Entry system IDs

Array

Collection of iList entry system IDs to retrieve.

Each ID represents an iList entry.

ResponseListIlistEntry

A standard response wrapper that returns multiple iList entries for iList search endpoints. Combines the requested iList entry data with response‑level status information.

Field	Name	Type	Description
`data`	iList entries	Array	A collection of iList entries that match the submitted search criteria. Contains `IlistEntry` data.
`status`	Response status	Object	Metadata about the response. Contains `ResponseStatus` data.

Field

Name

Type

Description

data

iList entries

Array

A collection of iList entries that match the submitted search criteria.

Contains IlistEntry data.

status

Response status

Object

Metadata about the response.

Contains ResponseStatus data.

ResponseIlistEntry

A standard response wrapper that returns a single iList entry for iList lookup endpoints. Combines the requested iList entry data with response‑level status information.

Field	Name	Type	Description
`data`	iList entry	Object	The iList entry for a specified iList entry ID. Contains `IlistEntry` data.
`status`	Response status	Object	Metadata about the response. Contains `ResponseStatus` data.

Field

Name

Type

Description

data

iList entry

Object

The iList entry for a specified iList entry ID.

Contains IlistEntry data.

status

Response status

Object

Metadata about the response.

Contains ResponseStatus data.

IlistEntry

A single iList entry record with identifying, descriptive, and contextual information about the associated entity.

Field	Name	Type	Description
`listEntrySysId`	Entry system ID	String	A system‑generated identifier for an iList entry.
`listTrackingId`	List tracking ID	String	A tracking identifier associated with an iList entry.
`listType`	List type	String	Indicates the category of an iList entry.
`name`	Name	String	The primary name of an entry on an iList.
`birthDt`	Birth date	Array	One or more birth dates associated with an iList entry. Format: `YYYY‑MM‑DD`.
`status`	Status	String	Indicates whether the iList entry is active or otherwise flagged for screening purposes.
`listEntry`	List entry metadata	Object	iList entry metadata. Contains `ListEntry` data.
`event`	Event	Array	Grid risk events related to an iList entry. Contains `Event` data.
`alias`	Aliases	Array	Alternate names for an iList entry. Contains `Alias` data.
`postAddr`	Postal address	Array	Address details associated with an iList entry. Contains `PostAddr` data.
`rdcId`	Grid identifier	Array	Identifier assigned by the Grid system. Contains `RdcId` data.
`additionalInfo`	Additional information	Array	Supplemental information for an iList entry. Contains `AdditionalInfo` data.
`entryRule`	Entry rule	Array	Rules or criteria applied to an iList entry. Contains `EntryRule` data.

ListEntry

Metadata about the list, for example, a sanctions or watchlist, to which an iList entry belongs.

Field	Name	Type	Description
`name`	List name	String	The name of the list on which an iList entry appears.
`description`	Description	String	A human-readable description of an iList.
`source`	Source	Array	Contains originating source information for an iList. Contains `Source` data.

Field

Name

Type

Description

name

List name

String

The name of the list on which an iList entry appears.

description

Description

String

A human-readable description of an iList.

source

Source

Array

Contains originating source information for an iList.

Contains Source data.

Source

Reference details that describe the origination of iList data for entries, lists, or related events.

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

An iList entry risk event, with details about activities, designations, or occurrences.

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.

Field	Name	Type	Description
`categoryCode`	`Category code`	String	A code representing the event category. See Grid risk event codes for more information.
`categoryDesc`	`Category description`	String	A human‑readable, descriptive explanation for the event category code.

Alias

Additional names under which an iList entry entity may be known,

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

PostAddr

A postal address associated with an iList entry.

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`

RdcId

A Grid-assigned identifier, used to associate an iList entry with other internal Grid identifiers.

Field	Name	Type	Description
`rdcIdTyp`	Grid ID type	String	The type of identifier used to reference an iList entry within Grid systems.
`rdcIdVal`	Grid ID value	String	The value of the identifier used to reference an iList entry within Grid systems.

AdditionalInfo

Supplementary descriptive information for an entry that does not fit into standard iList fields.

Field	Name	Type	Description
`info`	Additional information	String	Free‑form descriptive details for an iList entry.

EntryRule

A rule, criterion, or condition that explains why an entity appears on an iList.

Field	Name	Type	Description
`entryRuleDescription`	Entry rule description	String	A text description of the rule associated with an iList entry.

ResponseStatus

The primary response status, indicating success, failure, or completion with warnings.

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

Supplementary status information associated with an API response. This object provides additional messages beyond the primary response 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.

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.

Additional information

In this section:

iList data

IlistEntryRequest

ResponseListIlistEntry

ResponseIlistEntry

IlistEntry

ListEntry

Source

Event

Category

Alias

PostAddr

RdcId

AdditionalInfo

EntryRule

ResponseStatus

AdditionalResponseStatus

Additional information

Search results