ScreeningResult schema

Result returned by POST /screenings and plain GET /results items. Its required fields are always present. A successful result is either potential_match or no_match; failures use the Error envelope instead.

idRequired

string

Screening UUID; use it to retrieve retained result/evidence and locate linked review cases.

Format: uuid.

environmentRequired

enum

Environment owned by the API key. Sandbox evidence is synthetic.

Values: "sandbox", "production".

statusRequired

enum

potential_match requires review of candidates; no_match means no returned candidates within the selected coverage and matching rules. Neither is a business approval or legal clearance.

Values: "potential_match", "no_match".

createdAtRequired

string

Screening creation timestamp in ISO 8601 UTC.

Format: date-time.

matchesRequired

object[]

Candidate records with field evidence and conflicts. Always an array; empty for no_match. No silent truncation is performed.

matches item fields

Each array item: object.

matches[].recordRequired

objectView SourceRecord schema

matches[].record fields and rules

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

matches[].scoreRequired

number

Legacy composite review score retained for compatibility. Use assessment.name.similarity for name similarity and assessment for corroboration and conflicts. Not a probability of identity or wrongdoing.

Minimum: 0. Maximum: 100.

matches[].assessmentOptional

object

Retained name similarity, identity comparison states and review evidence tier. Contains no copied subject values. Missing information, conflicts and partial dates remain distinct; an evidence tier is not a finding of identity or wrongdoing.

View MatchAssessment schema

matches[].assessment fields and rules

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

matches[].evidenceRequired

object[]

matches[].evidence item fields

Each array item: object.

matches[].evidence[].fieldRequired

string

matches[].evidence[].queryValueRequired

string

matches[].evidence[].sourceValueRequired

string

matches[].evidence[].methodRequired

string

matches[].evidence[].contributionRequired

number

matches[].evidence[].explanationRequired

string

matches[].conflictsRequired

string[]

matches[].conflicts item fields

Each array item: string.

coverageRequired

Coverage[]

Exact source versions used, including freshness and retained publisher notices. Always present, including no_match.

coverage item fields

Each array item: Coverage.

coverage[].sourceIdRequired

string

coverage[].versionRequired

string

coverage[].retrievedAtRequired

string

Format: date-time.

coverage[].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.

coverage[].publishedAt fields and rules

Choose exactly one option

• string

  Format: date.

• string

  Format: date-time.

coverage[].freshRequired

boolean

coverage[].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

coverage[].sourceNotice fields and rules

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

versionsRequired

object

Dataset, matching engine and policy versions used for this result. package is included only for package-based coverage.

versions fields and rules

versions.datasetRequired

string

versions.matchingEngineRequired

string

versions.policyRequired

string

versions.packageOptional

string

disclaimerRequired

string

Interpretation limits supplied with this result; preserve them when presenting or exporting evidence.

policySnapshotOptional

object

Immutable organization policy applied at screening time, when one was selected. Omitted when no organization policy applied.

View ScreeningPolicySnapshot schema

policySnapshot fields and rules

policySnapshot.nameRequired

string

Minimum length: 2. Maximum length: 120.

policySnapshot.purposeRequired

string

Minimum length: 3. Maximum length: 1000.

policySnapshot.jurisdictionsRequired

string[]

Minimum items: 1. Maximum items: 30.

policySnapshot.jurisdictions item fields

Each array item: string.

Minimum length: 2. Maximum length: 100.

policySnapshot.matchingOptional

object

policySnapshot.matching fields and rules

policySnapshot.matching.profileRequired

string

Values: "standard", "focused".

policySnapshot.matching.partialNamesOptional

string

Values: "review", "exclude".

Additional fields are not accepted.

policySnapshot.requiredSourcesRequired

object

Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.

policySnapshot.requiredSources fields and rules

Each additional key uses the following value structure.

Maximum items: 512.

Each array item: string.

Minimum length: 1. Maximum length: 80.

policySnapshot.optionalSourcesRequired

object

Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.

policySnapshot.optionalSources fields and rules

Each additional key uses the following value structure.

Maximum items: 512.

Each array item: string.

Minimum length: 1. Maximum length: 80.

policySnapshot.exclusionsRequired

string[]

Maximum items: 30. Default: [].

policySnapshot.exclusions item fields

Each array item: string.

Minimum length: 3. Maximum length: 500.

policySnapshot.externalChecksRequired

string[]

Maximum items: 20. Default: [].

policySnapshot.externalChecks item fields

Each array item: string.

Minimum length: 3. Maximum length: 200.

policySnapshot.externalCheckGuidanceOptional

object[]

Maximum items: 20.

policySnapshot.externalCheckGuidance item fields

Each array item: object.

policySnapshot.externalCheckGuidance[].labelRequired

string

Minimum length: 3. Maximum length: 200.

policySnapshot.externalCheckGuidance[].instructionsRequired

string

Minimum length: 3. Maximum length: 2000.

policySnapshot.externalCheckGuidance[].evidenceExampleOptional

string

Minimum length: 3. Maximum length: 1000.

Additional fields are not accepted.

policySnapshot.reviewRequired

object

Default: {}.

policySnapshot.review fields and rules

policySnapshot.review.requireSecondReviewOptional

boolean

Default: false.

policySnapshot.review.secondReviewForOptional

string[]

Maximum items: 4. Default: [].

policySnapshot.review.secondReviewFor item fields

Each array item: string.

Values: "same_identity", "allow", "restrict", "escalate".

policySnapshot.review.approverRolesOptional

string[]

Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].

policySnapshot.review.approverRoles item fields

Each array item: string.

Values: "owner", "admin", "analyst".

Additional fields are not accepted.

policySnapshot.monitoringIntervalHoursRequired

6 or 24 or 168

Default: 24.

policySnapshot.monitoringIntervalHours fields and rules

Allowed alternatives

• 6

  Must equal 6.

• 24

  Must equal 24.

• 168

  Must equal 168.

policySnapshot.retentionTriggerRequired

string

Values: "review_completed", "relationship_ended", "business_event". Default: "review_completed".

policySnapshot.idRequired

string

Format: uuid.

policySnapshot.versionRequired

integer

Minimum: 0.

policySnapshot.environmentRequired

string

Values: "sandbox", "production".

policySnapshot.createdAtRequired

string

Format: date-time.

Additional fields are not accepted.

matchingOptional

object

Applied Standard or Focused alert profile, comparison thresholds, partial-name policy and retrieval version. Saved with new results, including no-match results; omitted on historical results without this evidence. Set matching.partialNames to review on an approved screening policy to include weaker token-prefix and missing-name-part evidence. Omission or exclude preserves complete-name matching. Select sensitivity through a versioned policy, not an arbitrary request-level cutoff.

View AppliedMatchingPolicy schema

matching fields and rules

matching.versionRequired

string

matching.profileRequired

string

Values: "standard", "focused".

matching.nameThresholdRequired

integer

Minimum: 0. Maximum: 100.

matching.corroboratedNameThresholdRequired

integer

Minimum: 0. Maximum: 100.

matching.retrievalVersionRequired

string

matching.partialNamesOptional

string

Values: "review", "exclude".

Additional fields are not accepted.

warningsOptional

object[]

Input limitations without copied subject values. A one-word person name produces limited_name_information; legitimate single-word names are accepted. Preserve this warning with no-match outcomes and retained evidence. Historical results may omit it.

warnings item fields

Each array item: object.

warnings[].codeRequired

enum

Values: "limited_name_information".

warnings[].messageRequired

string

Additional fields are not accepted.