API REFERENCE · SCHEMA

MonitorRecordPreview schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

Bounded publisher-record preview. Each collection contains at most three entries; names, identifiers and designation text are shortened. Read the linked retained result for full evidence.

namesRequired
object[]
names item fields

Each array item: object.

names[].valueRequired
string
names[].kindRequired
enum

Values: "primary", "alias".

names[].qualityOptional
enum

Values: "strong", "weak", "unknown".

names[].scriptOptional
string
names[].provenanceOptional
object

Publisher field attribution. rawValue is optional; when present it preserves the original published value.

View SourceProvenance schema
names[].provenance fields and rules

See all SourceProvenance fields for the complete structure, required properties and constraints.

identifiersRequired
object[]
identifiers item fields

Each array item: object.

identifiers[].typeRequired
string
identifiers[].valueRequired
string
identifiers[].issuerOptional
string
identifiers[].provenanceOptional
object

Publisher field attribution. rawValue is optional; when present it preserves the original published value.

View SourceProvenance schema
identifiers[].provenance fields and rules

See all SourceProvenance fields for the complete structure, required properties and constraints.

birthDatesRequired
object[]
birthDates item fields

Each array item: object.

birthDates[].valueRequired
string
birthDates[].precisionRequired
enum

Values: "day", "month", "year", "range", "unknown".

birthDates[].originalRequired
string
nationalitiesRequired
string[]
nationalities item fields

Each array item: string.

designationsRequired
object[]
designations item fields

Each array item: object.

designations[].categoryRequired
enum

Values: "financial_sanctions", "export_control", "debarment", "other".

designations[].programsRequired
string[]
designations[].programs item fields

Each array item: string.

designations[].legalReferencesRequired
string[]
designations[].legalReferences item fields

Each array item: string.

designations[].wordingOptional
string
designations[].effectiveDateOptional
string