API REFERENCE · SCHEMA

Coverage 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.

sourceIdRequired
string
versionRequired
string
retrievedAtRequired
string

Format: date-time.

publishedAtOptional
string

Authority-supplied publication date (YYYY-MM-DD) or RFC 3339 timestamp, preserving the precision supplied by the publisher. A date-only value does not imply midnight or a timezone. Omitted when no genuine publication date or timestamp is supplied.

publishedAt fields and rules

Choose exactly one option

  • string

    Format: date.

  • string

    Format: date-time.

freshRequired
boolean
sourceNoticeOptional
object

Included in new production screening results, including no-match results. Absent from synthetic sandbox coverage and older retained evidence; historical evidence is not rewritten.

View SourceNotice schema
sourceNotice fields and rules
sourceNotice.textRequired
string

Required publisher attribution and reuse notices captured when screening runs.

sourceNotice.sourceUrlRequired
string

Format: uri.

sourceNotice.termsUrlRequired
string

Format: uri.

sourceNotice.licenseUrlOptional
string

Only included for a reviewed explicit license instrument.

Format: uri.

sourceNotice.databaseDownloadUrlOptional
string

Free complete derivative database for the exact immutable source version, where required. A relative path resolves against this API origin.

Format: uri-reference.

Use Coverage in a workflow

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides