API REFERENCE · SCHEMA

SourceRecord 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

idRequired

string

sourceIdRequired

string

authorityRequired

string

listRequired

string

sourceUrlRequired

string

entityTypeRequired

string

Values: "person", "organization", "vessel", "aircraft", "other".

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

addressesRequired

object[]

addresses item fields

Each array item: object.

addresses[].textOptional: string
addresses[].countryOptional: string
addresses[].provenanceOptional: object
Publisher field attribution. rawValue is optional; when present it preserves the original published value.
View SourceProvenance schema; addresses[].provenance fields and rules
See all SourceProvenance fields for the complete structure, required properties and constraints.

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

dataThroughOptional

string

Inclusive publisher data-availability deadline; not a legal end date.

Format: date.

screeningPeriodsOptional

object[]

Inclusive UTC date intervals for current screening. Omitted means no date filter; an empty array excludes the record from current screening.

Maximum items: 1000.

screeningPeriods item fields

Each array item: object.

screeningPeriods[].fromOptional: string
Format: date.
screeningPeriods[].throughOptional: string
Format: date.

Additional fields are not accepted.

publicContextOptional

object[]

Maximum items: 100.

publicContext item fields

Each array item: object.

publicContext[].labelRequired: string
Maximum length: 100.
publicContext[].valueRequired: string
Maximum length: 2000.

Additional fields are not accepted.

extensionsRequired

object

Source-specific published extensions. Keys and value shapes vary by source; preserve unknown values without assuming a fixed schema.

extensions fields and rules

Additional keys are allowed; their values are not a fixed contract.