# Sex Offender Search API enums
> Every closed vocabulary the Sex Offender Search API accepts or returns, with every value and where it appears.
- **HTML:** https://offendersearch.app/docs/enums
- **OpenAPI:** https://offendersearch.app/openapi.json

Direction says whether a value is sent (request), received (response) or both. Treat an unrecognised value as `other` and log it; values are added, never removed or renamed.

| Field | Where | Direction | Values | Default |
| --- | --- | --- | --- | --- |
| `clearanceMode` | [The SearchRequest object](https://offendersearch.app/docs/search#reference-post-v1-search) | request | `suppress` · `annotate` · `ignore` | `suppress` |
| `evidence` | [The LiveBlock object — live verification request fields](https://offendersearch.app/docs/freshness#object-liveblock) | request | `none` · `pdf` | — |
| `exclude` | [The SearchRequest object](https://offendersearch.app/docs/search#reference-post-v1-search) | request | `stateData` | — |
| `format` | [The ProofRequest object — proof document request fields](https://offendersearch.app/docs/reports#object-proofrequest) | request | `pdf` · `html` | `pdf` |
| `include` | [The SearchRequest object](https://offendersearch.app/docs/search#reference-post-v1-search) | request | `stateData` · `raw` · `extensive` | — |
| `match` | [POST /v1/batch request](https://offendersearch.app/docs/batch#reference-post-v1-batch) | request | `strict` · `balanced` · `broad` | — |
| `match` | [The SearchRequest object](https://offendersearch.app/docs/search#reference-post-v1-search) | request | `strict` · `balanced` · `broad` | `balanced` |
| `nameMatch.firstName` | [The Query object — sex offender search request fields](https://offendersearch.app/docs/search#object-query) | request | `exact` · `prefix` · `nickname` · `fuzzy` · `middle` | — |
| `nameMatch.lastName` | [The Query object — sex offender search request fields](https://offendersearch.app/docs/search#object-query) | request | `exact` · `prefix` · `fuzzy` | — |
| `onAgeMismatch` | [The Query object — sex offender search request fields](https://offendersearch.app/docs/search#object-query) | request | `drop` · `flag` | `drop` |
| `onDeadline` | [POST /v1/batch request](https://offendersearch.app/docs/batch#reference-post-v1-batch) | request | `partial` · `error` | `partial` |
| `onDeadline` | [The SearchRequest object](https://offendersearch.app/docs/search#reference-post-v1-search) | request | `partial` · `error` | `partial` |
| `product` | [The ClearanceCreate object](https://offendersearch.app/docs/clearances#reference-post-v1-clearances) | request | `sex_offender` · `criminal` | `sex_offender` |
| `recordTypes` | [The SearchRequest object](https://offendersearch.app/docs/search#reference-post-v1-search) | request | `sex_offender` | `sex_offender` |
| `scope` | [The LiveBlock object — live verification request fields](https://offendersearch.app/docs/freshness#object-liveblock) | request | `matched` | — |
| `verdict` | [The ClearanceCreate object](https://offendersearch.app/docs/clearances#reference-post-v1-clearances) | request | `not_this_person` · `this_person` | — |
| `status` | [GET /v1/searches/{searchId}/results · 202](https://offendersearch.app/docs/async-and-webhooks#reference-get-v1-searches-searchid-results) | response | `pending` · `running` | — |
| `cappedReason` | [The SearchResponse object](https://offendersearch.app/docs/search#reference-post-v1-search) | both | `responseLimit` | — |
| `detail.code` | [The RateLimitError object — 429 rate limit response fields](https://offendersearch.app/docs/errors#object-ratelimiterror) | both | `rate_limited` · `overloaded` | — |
| `dobPrecision` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `exact` · `year` · `year_month` · `unknown` | — |
| `dobVerification` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `` · `dob_match` · `year_match` · `age_match` · `unverified_no_dob_or_age` · `dob_mismatch(filtered)` · `age_mismatch(filtered)` · `age_mismatch(flagged)` | — |
| `documents.format` | [The ProofBundle object — proof document response fields](https://offendersearch.app/docs/reports#object-proofbundle) | both | `pdf` · `html` | — |
| `health.freshFor` | [The SourceInfo object](https://offendersearch.app/docs/freshness#reference-get-v1-sources) | both | `daily` · `weekly` | — |
| `housingStatus` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `homeless` · `incarcerated` · `housed` | — |
| `incompleteReason` | [The SourceStatus object — per-registry status fields](https://offendersearch.app/docs/result-completeness#object-sourcestatus) | both | `deadline` · `truncated` · `excluded` · `not_searched` · `unavailable` · `error` | — |
| `incompleteReason` | [The EvidenceDocument object — one registry's printed page](https://offendersearch.app/docs/live-evidence#object-evidencedocument) | both | `no_recipe` · `renderer_unavailable` · `source_unreachable` · `blocked` · `timed_out` · `no_results_page` · `render_failed` · `query_unsupported` | — |
| `kind` | [The EvidenceDocument object — one registry's printed page](https://offendersearch.app/docs/live-evidence#object-evidencedocument) | both | `text` · `image` · `mixed` | — |
| `legal.commercialUse` | [The SourceInfo object](https://offendersearch.app/docs/freshness#reference-get-v1-sources) | both | `allowed` · `restricted` · `prohibited` · `unknown` | — |
| `matchDetail.matchedNameType` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `legal` · `alias` | — |
| `matchDetail.signals` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `matchedLegalName` · `matchedAlias` · `matchedMiddleName` · `unverifiable` · `linkedByRegistryId` | — |
| `matchedName.type` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `legal` · `alias` | — |
| `matchState` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `dob_match` · `year_match` · `age_match` · `no_dob_age_year` · `age_mismatch` · `dob_mismatch` | — |
| `mode` | [The EvidenceAccepted object](https://offendersearch.app/docs/live-evidence#reference-post-v1-search-live-evidence) | both | `async` | — |
| `product` | [The Clearance object — every field on a recorded verdict](https://offendersearch.app/docs/clearances#object-clearance) | both | `sex_offender` · `criminal` | — |
| `recordType` | [Field reference — every field on the sex offender Record object](https://offendersearch.app/docs/record-object#record-fields) | both | `sex_offender` | `sex_offender` |
| `scope` | [The SourceInfo object](https://offendersearch.app/docs/freshness#reference-get-v1-sources) | both | `state` · `national` | — |
| `staleReason` | [The RecordClearance object — the clearance attached to a kept record](https://offendersearch.app/docs/clearances#object-recordclearance) | both | `identity_changed` · `offenses_changed` · `status_changed` · `stronger_match` | — |
| `status` | [The SearchResponse object](https://offendersearch.app/docs/search#reference-post-v1-search) | both | `complete` · `partial` · `running` · `pending` · `error` | — |
| `status` | [The SourceStatus object — per-registry status fields](https://offendersearch.app/docs/result-completeness#object-sourcestatus) | both | `ok` · `error` · `restricted` · `no_coverage` · `complete` · `partial` | — |
| `status` | [The EvidenceAccepted object](https://offendersearch.app/docs/live-evidence#reference-post-v1-search-live-evidence) | both | `pending` | — |
| `status` | [The EvidenceDocument object — one registry's printed page](https://offendersearch.app/docs/live-evidence#object-evidencedocument) | both | `complete` · `incomplete` | — |
| `status` | [The AsyncSearchAccepted object](https://offendersearch.app/docs/async-and-webhooks#reference-post-v1-searches) | both | `pending` · `running` | — |
| `status` | [The ProofBundle object — proof document response fields](https://offendersearch.app/docs/reports#object-proofbundle) | both | `none` · `rendering` · `ready` | — |
| `status` | [The SourceInfo object](https://offendersearch.app/docs/freshness#reference-get-v1-sources) | both | `building` · `live` | — |
| `verdict` | [The Clearance object — every field on a recorded verdict](https://offendersearch.app/docs/clearances#object-clearance) | both | `not_this_person` · `this_person` | — |
| `verdict` | [The ClearedEntry object — one person a clearance hid from this response](https://offendersearch.app/docs/clearances#object-clearedentry) | both | `not_this_person` | — |
| `verdict` | [The RecordClearance object — the clearance attached to a kept record](https://offendersearch.app/docs/clearances#object-recordclearance) | both | `not_this_person` · `this_person` | — |
