API REFERENCE · SCHEMA
Applied
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.
Effective matching profile, partial-name policy and retrieval version retained at screening, including no-match results. Historical results can omit this snapshot. Partial names are excluded unless an approved policy explicitly enables review. Scores are not population-calibrated probabilities.
versionRequired- string
profileRequired- string
Values: "standard", "focused".
nameThresholdRequired- integer
Minimum: 0. Maximum: 100.
corroboratedNameThresholdRequired- integer
Minimum: 0. Maximum: 100.
retrievalVersionRequired- string
partialNamesOptional- string
Values: "review", "exclude".
Additional fields are not accepted.
Use AppliedMatchingPolicy in a workflow
Used by
Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.
- POST /screeningsResponse · Screen one subject against explicitly selected coverage
- GET /resultsResponse · List retained results
- GET /results/{id}Response · Retrieve one retained screening
- GET /results/{id}/evidenceResponse · Download retained JSON evidence
- GET /reports/cases/{id}Response · Download a bounded case audit packet in JSON or PDF
- GET /reports/cases/{id}/archiveResponse · Export every retained case archive segment