Documentation menu
SearchResponse
Fields, types and constraints for the SearchResponse public API model.
Ranked search results and the effective search scope.
Fields
| Field | Type | Constraint | Example | Visibility |
|---|---|---|---|---|
statusWhether the operation completed successfully. | boolean | — | false | Public contract |
totalTotal records matching the filters. | integer | — | 0 | Public contract |
pageOne-based page number. | integer | — | 0 | Public contract |
pageSizeRequested or returned records per page. | integer | — | 0 | Public contract |
resultsCandidate results ordered by score. | SearchResultItem[] | — | [] | Public contract |
metaNormalized query, source and policy context. | object | nullable | {} | Public contract |
Machine-readable schema
The model is published under the same name in the JSON Schema bundle.
JSON SchemaDecision boundary
An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.