Skip to main content

Inquiry and batch data

Abstract

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

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

Batch

Contains the batch identifier, processing status, target firm number, and the collection of inquiries included in the batch.

Field

Name

Type

Description

id

Batch ID

String

Unique, system-assigned identifier for a batch.

status

Status

String

Current status of the batch.

Possible values: COMPLETE, PROCESSING, or ERASED.

gridInquiries

Grid inquiries

Object

The inquiries included in the batch.

Contains Inquiry data.

targetFirmNumber

Target firm number

String

Identifier for a Grid firm. This routes the request to the correct firm configuration.

Inquiry

The core inquiry record used throughout /inquiry endpoints, capturing the submitted name information, processing attributes, and screening settings used in an inquiry.

Field

Name

Type

Description

id

Inquiry ID

String

System-assigned identifier for an inquiry. Inquiry IDs are unique by firm, but can be reused across firms and environments.

Example format: 12345.

batchId

Batch ID

String

Unique, system-assigned identifier for a batch.

Example format: 67890.

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.

completedDate

Completed date

String

A UTC timestamp of an inquiry's completion.

Example format: 2025-06-15T14:30:00Z

status

Status

String

Current status of the inquiry.

Possible values: COMPLETE, PROCESSING, or ERASED.

reviewStatus

Review status

String

The inquiry's Analyst Review status.

Possible values:

  • ALERT: Potential matches generated an alert for at least one matched entity.

  • DECISIONED_ALERT: Matches decisioned as alerts by the client firm in Client Alert Decisioning.

  • NO_REVIEW: Matches screened without review byMoody's or the client firm.

  • NOMATCH: No matches for the inquiry.

  • DECISIONED_NOMATCH: Matches decisioned as non-matches by the client firm in Client Alert Decisioning.

  • DECISIONED_IGNORE: Matches decisioned as ignored by the client firm in Client Alert Decisioning.

  • DECISIONING_REVIEW: Inquiry is under review by the client firm in Client Alert Decisioning.

  • MANUAL_REVIEW: Inquiry is under review by Moody's Analyst Review.

  • LOAD: Inquiries are loaded directly into Portfolio Monitoring, bypassing inquiry screening.

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.

When absent, treat as 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.

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

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.

statusType

Status type

Object

Status details.

Contains Status data.

note

Note

String

Additional free-text notes for the inquiry.

Character limit: 4000

alerts

Alerts

Array

Alerts associated with an inquiry.

Contains GridAlertRecType data.

targetFirmNumber

Target firm number

String

Identifier for a Grid firm. This routes the request to the correct firm configuration.

GridPersonPartyInfo

In person‑based inquiry requests and responses, this contains an organization’s core data, context, attributes, and pictures.

Field

Name

Type

Description

partyContext

Party context

Object

Contextual information for the person.

Contains PartyContext data and note.

pictures

Pictures

Object

A collection of picture objects associated with the person.

Contains Pictures data.

attribute

Attributes

Array

Additional attributes recorded for the person.

Contains Attribute data.

gridPersonData

Grid person data

Object

The person’s core data record.

Contains GridPersonData data.

birthDt

Birth date

String

Birth date of a person.

Allowed formats: YYYY-MM-DD, YYYY-MM or YYYY.

age

Age

Integer

Age of the person.

sex

Sex

String

Gender indicator.

Possible values: M and F.

GridPersonData

In person‑based inquiry requests and responses, this provides the organization’s name, identifier, and contact information.

Field

Name

Type

Description

gridContact

Grid contact

Object

Provides contact details for the person.

Contains GridContact data.

entityIdentifier

Entity ID

String

Unique identifier for the entity.

personName

Person name

Object

The full name details for the person.

Contains PersonName data.

PersonName

Identifies a person's primary or official name as supplied in an inquiry.

Field

Name

Type

Description

fullName

Full name

String

The complete name of a person as a single string.

Character limit: 128

familyName

Family name

String

The family name, surname, or last name of a person. 

Character limit: 50

givenName

Given name

String

The given name or first name of a person. 

Character limit: 50

middleName

Middle name

String

The middle name or additional given names of a person, if available.

Character limit: 50

GridOrgPartyInfo

In organization‑based inquiry requests and responses, this contains an organization’s core data, context, attributes, and pictures.

Field

Name

Type

Description

partyContext

Party context

Object

Provides contextual information about the organization.

Contains PartyContext and note.

pictures

Pictures

Object

Associated pictures.

Contains Pictures data.

attribute

Attributes

Array

Collection of additional attributes for the organization.

Each attribute contains Attribute data.

gridOrgData

Grid organization data

Object

The organization’s core data record.

Contains GridOrgData data.

GridOrgData

In organization‑based inquiry requests and responses, this provides the organization’s name, identifier, and contact information.

Field

Name

Type

Description

gridContact

Grid contact

Object

Provides contact details for the organization.

Contains GridContact data.

entityIdentifier

Entity ID

String

Unique identifier for the entity.

orgName

Organization name

Object

The organization name.

Contains OrgName data, which includes the required name field.

OrgName

Identifies an organization's primary or official name as supplied in an inquiry.

Field

Name

Type

Description

name

Name

String

The formal or recognized organization name used for screening, matching, and reporting.

Character limit: 128

GridUnknownPartyInfo

In unknown inquiry requests and responses, this contains an organization’s core data, context, attributes, and pictures. Used when the party type cannot be classified as a person or organization.

Field

Name

Type

Description

partyContext

Party context

Object

Contextual information for an unknown party type.

Contains PartyContext data.

pictures

Pictures

Object

Associated pictures.

Contains Pictures data.

attribute

Attributes

Array

Additional attributes.

Contains Attribute data.

gridUnknownData

Grid unknown data

Object

Unknown party-specific data.

Contains GridUnknownData data.

birthDt

Birth date

String

Birth date if available.

age

Age

Integer

Age if available.

sex

Sex

String

Gender indicator.

Possible values: M and F.

GridUnknownData

In unknown inquiry requests and responses, this provides the entity's name, identifier, and contact information. Used when the party type cannot be classified as a person or organization.

Field

Name

Type

Description

gridContact

Grid contact

Object

Contact details associated with the unknown party type.

Contains GridContact data.

entityIdentifier

Entity ID

String

Unique identifier for the entity.

unknownName

Unknown name

Object

Name information for the unknown party.

Contains UnknownName data, which includes the required name field.

UnknownName

The name provided in an inquiry when an entity cannot be confidently classified as a person or an organization.

Field

Name

Type

Description

name

Name

String

The name associated with an unknown or unclassified party.

Character limit: 128

PartyContext

Contextual metadata associated with a person, organization, or unknown entity.

Field

Name

Type

Description

note

Note

String

Free‑text contextual note associated with the party. This may contain descriptive information provided by the source or used internally for context or qualifiers.

Character limit: 4000

Pictures

Contains a collection of picture objects associated with the party. Only used when providing a photo in the inquiry request. The picture field contains PictureTyp data with the fields defined in the following table.

Field

Name

Type

Description

pictureData

Picture data

Object

Contains DataHandler data.

pictureTyp

Picture type

String

Indicates the type of picture.

DataHandler

Only used with PicturesType in requests. Contains content such as PDF and images along with source, content type, and transfer format data.

Field

Name

Type

Description

allCommands

All commands

Array

Available commands for handling the data.

Contains commandName and commandClass.

commandClass

Command class

String

Class associated with the command.

commandName

Command name

String

Name of the command.

contentType

Content type

String

MIME type of the content.

Example values: image or jpeg.

content

Content

Object

Contains content-related metadata.

dataSource

Data source

Object

References the underlying data source for this handler.

Contains DataSource data.

DataSource

Only used with PicturesType in requests. A wrapper for binary or streaming content.

Field

Name

Type

Description

inputStream

Input stream

Object

Input stream object for reading data into the handler.

name

Name

String

Name associated with the data handler.

outputStream

Output stream

Object

The output stream for the picture data.

preferredCommands

Preferred commands

Array

Preferred commands for handling the data.

Contains the commandName and commandClass fields.

transferDataFlavors

Transfer data flavors

Array

Collection of supported data flavors for transferring data.

Contains DataFlavor data.

DataFlavor

Only used with PicturesType in requests. Describes the format, MIME type, and supported transfer mechanisms of binary or serialized content.

Field

Name

Type

Description

mimeType

MIME type

String

MIME type for the data flavor.

humanPresentableName

Human presentable name

String

A human-readable name for the data flavor.

defaultRepresentationClassAsString

Default representation class

String

Default representation class as a string.

flavorJavaFileListType

Java file list type

Boolean

Indicates if the flavor supports Java file list type.

Default value: false.

flavorRemoteObjectType

Remote object type

Boolean

Indicates if the flavor supports remote object type.

Default value: false.

flavorSerializedObjectType

Serialized object type

Boolean

Indicates if the flavor supports serialized object type.

Default value: false.

flavorTextType

Text type

Boolean

Indicates if the flavor supports text type.

Default value: false.

mimeTypeSerializedObject

MIME type serialized object

Boolean

Indicates if the MIME type supports serialized object.

Default value: false.

representationClassByteBuffer

Byte buffer representation

Boolean

Indicates if byte buffer representation is supported.

Default value: false.

representationClassCharBuffer

Character buffer presentation

Boolean

Indicates if character buffer representation is supported.

Default value: false.

representationClassInputStream

Input stream representation

Boolean

Indicates if input stream representation is supported.

Default value: false.

representationClassReader

Reader representation

Boolean

Indicates if reader representation is supported.

Default value: false.

representationClassRemote

Remote representation

Boolean

Indicates if remote representation is supported.

Default value: false.

representationClassSerializable

Serializable representation

Boolean

Indicates if serializable representation is supported.

Default value: false.

primaryType

Primary type

String

Primary type of the MIME type.

Default value: false.

subType

Sub type

String

Subtype of the MIME type.

Default value: false.

Attribute

Used in responses to contain supplemental attribute details that enhance Grid’s matching and screening context.

GridContact

In inquiry request bodies, provides both a primary address and an optional list of additional addresses for an entity.

Field

Name

Type

Description

addr

Address

Object

Primary address for the party.

Contains Addr data.

addresses

Addresses

Array

Up to three additional addresses associated with the party.

Contains Addr data.

Addr

Used in person and organization inquiry requests to supply location details that support Grid’s matching services.

Field

Name

Type

Description

addr1

Address

String

First line of the address.

Character limit: 255

city

City

String

City name.

Character limit: 255

stateProv

State or province

String

State or province name.

Character limit: 255

postalCode

Postal code

String

Postal or ZIP code.

Character limit: 15

countryCode

Country code

Object

Two-letter country code associated with the address.

Contains countryCodeValue.

countryCodeValue

Country code value

String

A value for the country name.

Character limit: 255

Format: ISO 3166-1 alpha-2

ResponseBatch

Contains the batch payload and the overall request outcome.

Field

Name

Type

Description

data

Batch data

Object

Contains batch details.

Contains Batch data.

status

Response status

Object

The status of the response.

Contains ResponseStatus data.

ResponseInquiry

Response that contains the fully populated Inquiry and a status indicating success or error.

Field

Name

Type

Description

data

Inquiry data

Object

Contains Inquiry data.

status

Response status

Object

Represents the status of the response.

Contains ResponseStatus data.

ResponseStatus

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

ResponsePaginatedInquiryResponse

Response wrapper containing paginated inquiry history records and an overall request status.

Field

Name

Type

Description

data

Inquiry data

Object

Contains PaginatedInquiryResponseInquiry data.

status

Response status

Object

Represents the status of the response.

Contains ResponseStatus data.

PaginatedInquiryResponse

Response with paginated inquiry history records.

Field

Name

Type

Description

items

Inquiry items

Array

List of inquiry history records.

Each item contains Inquiry data.

totalRecords

Total records

Integer

Total number of records available.

currentPage

Current page

Integer

Current page number.

pageSize

Page size

Integer

Number of records per page.

Default value: 20

Max value: 100.

totalPages

Total pages

Integer

Total number of pages.

AdditionalResponseStatus

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

GridInquiryStatus

Received in status request responses, this describes the current processing state of an inquiry.

Field

Name

Type

Description

effDt

Effective date

String

An ISO 8601 UTC date-time timestamp of the start of an inquiry status.

Example format: 2025-06-15T14:30:00Z

gridInquiryStatusCode

Inquiry status code

String

The processing state of the inquiry. 

Possible values: COMPLETE and PROCESSING.

statusDesc

Status description

String

A human‑readable explanation of the inquiry status.

Additional information

In this section: