> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gominerva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List stored potential matches

> Returns the potential matches Minerva has stored for your searches. Every search stores its potential matches, including each monitoring rescreen, and this endpoint reads them back by search request, profile, review status, suppression reason, allowlist status, or time window. Results are newest first by default.

A filter with several values returns matches that have any of them. When you use more than one filter, a match must meet all of them.

When the request is scoped to a workspace, for example with the `x-workspace-id` header, only that workspace's matches are returned.

**Match IDs.** Each item's `id` identifies one stored potential match. It is the same value that [`PATCH /v2/search/matches/{match_id}`](/api-reference/potential-matches/update-potential-match-status) accepts, so you can store it and use it later to record a review decision.

A synchronous [`POST /v2/search`](/api-reference/search/submit-a-v2-search) also returns this ID on each match as `screening_match_id`, when it is available. A match can also carry `record_id`, the data source's own identifier for the matched record. `record_id` isn't a match ID.

- The `id` does not change for as long as the match exists. Updating a match's review status keeps the same `id`.
- A new screening of the same subject, such as a monitoring rescreen, stores its matches with new IDs. Minerva never reuses the ID of an earlier match, so if a rescreen finds the same person or entity again, that potential match has a new `id` and the new screening's `request_id`.
- Minerva doesn't expire stored matches automatically, and archiving a profile doesn't remove its matches.

**Pagination.** Use `page` and `limit`, and read the `pagination` object in the response. `has_next` tells you whether another page exists. See [Search History](/api-reference/search-history) for monitoring and audit examples.

To audit allowlisting, filter by `suppression_reason=allowlist` (matches whose current suppression reason is Allowlisted) or by `allowlist_status` (how the allowlist screened the match, which stays on the match after a later review). For example, `allowlist_status=record_changed,record_not_covered` lists matches an entry no longer covers.



## OpenAPI

````yaml /api-reference/core.json get /v2/search/matches
openapi: 3.0.0
info:
  version: 1.6.2
  title: MinervaAI Core API
  description: >-
    The Minerva core monolith, which provides search, consensus, pruning, and
    report generation.
servers:
  - url: https://api.gominerva.com
    description: The production API server for Minerva.
security:
  - ApiKeyAuth: []
tags:
  - name: Search
    description: >-
      Current screening, search, and reporting endpoints for active
      integrations.
  - name: Legacy
    description: >-
      Legacy endpoints retained for backwards compatibility. Prefer the
      canonical POST-based search flows for new integrations.
  - name: API to UI Integration
    description: Endpoints used to bridge API integrations with Minerva UI workflows.
  - name: Potential Matches
    description: Update review workflow state for potential matches returned by searches.
  - name: Allowlists
    description: >-
      Capture a potential match for an allowlist entry and resolve open matches
      with a live entry. Allowlists themselves are managed through the custom
      lists Admin API.
paths:
  /v2/search/matches:
    get:
      tags:
        - Search
      summary: List stored potential matches
      description: >-
        Returns the potential matches Minerva has stored for your searches.
        Every search stores its potential matches, including each monitoring
        rescreen, and this endpoint reads them back by search request, profile,
        review status, suppression reason, allowlist status, or time window.
        Results are newest first by default.


        A filter with several values returns matches that have any of them. When
        you use more than one filter, a match must meet all of them.


        When the request is scoped to a workspace, for example with the
        `x-workspace-id` header, only that workspace's matches are returned.


        **Match IDs.** Each item's `id` identifies one stored potential match.
        It is the same value that [`PATCH
        /v2/search/matches/{match_id}`](/api-reference/potential-matches/update-potential-match-status)
        accepts, so you can store it and use it later to record a review
        decision.


        A synchronous [`POST
        /v2/search`](/api-reference/search/submit-a-v2-search) also returns this
        ID on each match as `screening_match_id`, when it is available. A match
        can also carry `record_id`, the data source's own identifier for the
        matched record. `record_id` isn't a match ID.


        - The `id` does not change for as long as the match exists. Updating a
        match's review status keeps the same `id`.

        - A new screening of the same subject, such as a monitoring rescreen,
        stores its matches with new IDs. Minerva never reuses the ID of an
        earlier match, so if a rescreen finds the same person or entity again,
        that potential match has a new `id` and the new screening's
        `request_id`.

        - Minerva doesn't expire stored matches automatically, and archiving a
        profile doesn't remove its matches.


        **Pagination.** Use `page` and `limit`, and read the `pagination` object
        in the response. `has_next` tells you whether another page exists. See
        [Search History](/api-reference/search-history) for monitoring and audit
        examples.


        To audit allowlisting, filter by `suppression_reason=allowlist` (matches
        whose current suppression reason is Allowlisted) or by
        `allowlist_status` (how the allowlist screened the match, which stays on
        the match after a later review). For example,
        `allowlist_status=record_changed,record_not_covered` lists matches an
        entry no longer covers.
      parameters:
        - name: x-workspace-id
          in: header
          required: false
          description: >-
            Workspace to read from. When present, only matches from this
            workspace are returned.
          schema:
            type: string
        - name: request_id
          in: query
          required: false
          description: >-
            Return the matches of one search request. Use the `request_id`
            returned by `POST /v2/search`, or the `id` of an item from `GET
            /v2/search/requests`.
          schema:
            type: string
        - name: profile_id
          in: query
          required: false
          description: >-
            Return the matches of one Minerva profile across all of its
            screenings.
          schema:
            type: string
        - name: match_ids
          in: query
          required: false
          description: >-
            Return only these matches. Pass a comma-separated list or repeat the
            parameter. Each value must be a 24-character hexadecimal match `id`;
            any other value returns `400`.
          schema:
            type: array
            items:
              type: string
              pattern: ^[0-9a-fA-F]{24}$
          style: form
          explode: false
        - name: review_status
          in: query
          required: false
          description: >-
            Return matches with one of these review statuses, for example
            `unresolved`. Pass a comma-separated list or repeat the parameter.
            Values are compared exactly, so use the lowercase values the API
            returns.
          schema:
            type: array
            items:
              type: string
              enum:
                - unresolved
                - reopened
                - true_positive
                - false_positive
                - suppressed
                - closed
                - not_found
          style: form
          explode: false
        - name: suppression_reason
          in: query
          required: false
          description: >-
            Filter suppressed matches by their current reason.
            `no_material_change` also matches suppressed matches stored without
            a reason. Unknown values return `400`.
          schema:
            type: array
            items:
              type: string
              enum:
                - allowlist
                - no_material_change
          style: form
          explode: true
        - name: allowlist_status
          in: query
          required: false
          description: >-
            Filter by `allowlist.status`, how the allowlist screened the match.
            Unknown values return `400`.
          schema:
            type: array
            items:
              type: string
              enum:
                - suppressed
                - would_suppress
                - partially_covered
                - subject_not_matched
                - details_not_matched
                - record_not_covered
                - record_changed
                - entry_expired
                - entry_lifetime_exceeded
          style: form
          explode: true
        - name: hit
          in: query
          required: false
          description: >-
            Return matches that carry a hit on at least one of these feeds. Use
            the feed names that appear as keys of a match's `hits`, for example
            `Sanctions`, `PEP`, `Criminal`, `Legal`, `News`, `Open Source`,
            `Social Media`, `Registries`, `Ownership`, `Offshore` or `Internal`.
            Pass a comma-separated list or repeat the parameter. Feed names are
            case-sensitive.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
        - name: created_at_from
          in: query
          required: false
          description: >-
            Inclusive lower bound for the match `created_at` time. Provide an
            RFC 3339 date-time with a timezone, for example
            `2026-11-01T00:00:00Z`, or a date such as `2026-11-01`, which starts
            at 00:00:00 UTC. A value in any other format returns an empty page
            rather than an error.
          schema:
            type: string
        - name: created_at_to
          in: query
          required: false
          description: >-
            Inclusive upper bound for the match `created_at` time. Provide an
            RFC 3339 date-time with a timezone, or a date such as `2026-11-30`,
            which runs to 23:59:59.999 UTC. A value in any other format returns
            an empty page rather than an error.
          schema:
            type: string
        - name: sort_key
          in: query
          required: false
          description: >-
            Field to sort by. `score` sorts by match score, and `review_status`
            groups matches by review status. Any other value sorts by
            `created_at`.
          schema:
            type: string
            enum:
              - created_at
              - score
              - review_status
            default: created_at
        - name: sort_direction
          in: query
          required: false
          description: Sort direction. Any value other than `asc` sorts descending.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: page
          in: query
          required: false
          description: One-based page number. Defaults to 1.
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: limit
          in: query
          required: false
          description: >-
            Number of matches per page. Defaults to 10. Values above 250 return
            250 matches per page.
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 250
      responses:
        '200':
          description: A page of stored potential matches.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchMatchesListResponse'
              example:
                pagination:
                  page: 1
                  limit: 10
                  total_count: 1
                  total_pages: 1
                  has_next: false
                  has_prev: false
                matches:
                  - id: 665f1c2b16f5adbb8e1d3f41
                    name:
                      value: Natwest Logistics LLC
                    review_status: suppressed
                    suppression_reason: allowlist
                    allowlist:
                      status: suppressed
                      mode: suppress
                      list:
                        id: cl_7f3a
                        name: Payee allowlist
                        version_id: clv_19e2
                        version_sequence: 5
                      decided_by: stage
                      evaluated_at: '2026-11-14T11:30:12Z'
        '400':
          description: >-
            Bad request. A query parameter is invalid, for example a malformed
            `match_ids` value or an unknown `suppression_reason` or
            `allowlist_status` value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageOnlyErrorBody'
        '401':
          description: Missing or invalid API key.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageOnlyErrorBody'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SearchMatchesListResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/SearchHistoryPagination'
        matches:
          type: array
          items:
            $ref: '#/components/schemas/StoredPotentialMatch'
        exclude_channels_applied:
          type: array
          items:
            type: string
        review_state_applied:
          type: string
          nullable: true
      required:
        - pagination
        - matches
    MessageOnlyErrorBody:
      type: object
      properties:
        message:
          type: string
          example: Missing required x-bulk-action-tenant-id header.
      required:
        - message
    SearchHistoryPagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 25
        total_count:
          type: integer
          example: 42
        total_pages:
          type: integer
          example: 2
        has_next:
          type: boolean
          example: true
        has_prev:
          type: boolean
          example: false
      required:
        - page
        - limit
        - total_count
        - total_pages
        - has_next
        - has_prev
    StoredPotentialMatch:
      allOf:
        - $ref: '#/components/schemas/PotentialMatchFields'
        - type: object
          properties:
            id:
              type: string
              description: >-
                Identifier of this stored potential match: 24 hexadecimal
                characters. Use it as `match_id` on `PATCH
                /v2/search/matches/{match_id}`. It does not change for as long
                as the match exists, and a later screening creates new matches
                with new IDs instead of reissuing this one.
              example: 665f1c2b16f5adbb8e1d3f41
            record_id:
              type: string
              description: >-
                The data source's own identifier for the matched record, when
                the source supplied one. It identifies the source record, not
                this match, so the same record can keep its `record_id` across
                screenings. It isn't a match ID: use `id` with the match
                endpoints.
              example: 018f4300-0000-7000-8000-000000000001
            request_id:
              type: string
              description: The search request that produced this match.
            index_in_request:
              type: integer
              description: Zero-based index of the screened entity within that request.
            profile_id:
              type: string
              description: >-
                Minerva profile the screening belongs to, when the search was
                linked to a profile.
            external_id:
              type: string
              description: >-
                Your external identifier for the screened entity, when one was
                supplied.
            custom_id:
              type: string
              description: >-
                Your custom identifier for the screened entity, when one was
                supplied.
            workspace_id:
              type: string
              description: Workspace the match belongs to.
            created_at:
              type: string
              format: date-time
              description: When the match was stored.
            updated_at:
              type: string
              format: date-time
              description: >-
                When the match was last updated, for example by a review status
                change.
            review_status:
              type: string
              enum:
                - unresolved
                - reopened
                - true_positive
                - false_positive
                - suppressed
                - closed
                - not_found
                - true_match
                - false_match
              description: >-
                The current review status of this stored match, in lowercase.
                New matches start as `unresolved`, and `PATCH
                /v2/search/matches/{match_id}` can change it to any of these
                values. `true_match` and `false_match` are legacy values that
                older matches may still carry. A `suppressed` match also carries
                `suppression_reason`, which says why: `no_material_change` (No
                Material Change) means Minerva's repeated alert suppression
                found no material change since an earlier reviewed match, or a
                reviewer marked it No Material Change; `allowlist` (Allowlisted)
                means your workspace allowlist suppressed it, and the
                `allowlist` object names the entry. Older responses may omit the
                reason; treat that as `no_material_change`.
              example: unresolved
          required:
            - id
            - request_id
            - index_in_request
            - created_at
            - updated_at
    PotentialMatchFields:
      type: object
      description: >-
        Fields shared by a potential match in a search response (`Profile`) and
        a stored potential match (`StoredPotentialMatch`). Each of those schemas
        adds its own `review_status`, because a stored match can carry statuses
        that a search response never returns.
      properties:
        type:
          type: integer
          enum:
            - 0
            - 1
          description: The type of profile. 0 for individual, 1 for organization.
          example: 0
        name:
          $ref: '#/components/schemas/SourcedName'
          description: The primary name of the profile with source lineage.
        last_updated:
          type: string
          description: String timestamp of when the profile was last updated.
          example: Saturday, Jun 26 2021 - 03:05:55 GMT00:00
        merge_id:
          type: string
          description: The unique ID of this profile in the knowledge graph.
          example: merge_abc123
        pep_level:
          type: integer
          minimum: 1
          maximum: 4
          description: PEP inference tier from 1-4, where 1 is highest risk.
          example: 2
        aliases:
          type: array
          description: >-
            Other known names for the profile, including names in non-Latin
            character sets.
          items:
            $ref: '#/components/schemas/SourcedName'
        gender:
          $ref: '#/components/schemas/SourcedGender'
          description: >-
            The gender of the profile. Only present for individual type
            profiles.
        company_type:
          $ref: '#/components/schemas/SourcedString'
          description: The type of company. Only present for organization type profiles.
        industry:
          $ref: '#/components/schemas/SourcedString'
          description: The industry of the profile.
        company_size:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The size of the company. Only present for organization type
            profiles.
        status:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The current status of the profile. For corporations, indicates
            company status such as "active" or "dissolved".
        occupation:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The job title or position of the individual. Only present for
            individual type profiles.
        organization:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The employer, affiliated entity, political party, or other
            organization associated with the individual. Only present for
            individual type profiles.
        nationality:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The known nationality or affiliated country of the profile. Contains
            the full country name.
        time_begin:
          $ref: '#/components/schemas/SourcedDate'
          description: >-
            The date of birth of the individual, or the date of
            incorporation/date active of the organization.
        time_end:
          $ref: '#/components/schemas/SourcedDate'
          description: >-
            If known/applicable, the date deceased of the individual or date of
            closure of the organization.
        alt_times:
          type: array
          description: Other known dates of birth or incorporation for the profile.
          items:
            $ref: '#/components/schemas/SourcedDate'
        place_of_birth:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The place of birth of the individual. May contain city, state,
            and/or country.
        contact:
          $ref: '#/components/schemas/ProfileContact'
          description: Contact information including email and phone.
        media:
          $ref: '#/components/schemas/ProfileMedia'
          description: >-
            Media for the profile, including adverse and neutral media URLs and
            social media usernames. Present when the News, Open Source, or
            Social Media feeds are included.
        locations:
          type: array
          description: >-
            Locations associated with the profile such as addresses, cities, or
            countries.
          items:
            $ref: '#/components/schemas/SourcedString'
        images:
          type: array
          description: Images associated with the profile.
          items:
            $ref: '#/components/schemas/SourcedString'
        other_fields:
          type: object
          description: Miscellaneous fields that do not fit within other defined fields.
          additionalProperties:
            $ref: '#/components/schemas/SourcedString'
        links:
          type: array
          description: >-
            Individuals, entities, or concepts linked to the profile. Includes
            family relationships (Father, Brother), ownership records (Director,
            Shareholder), and employee records (Chief Financial Officer).
          items:
            $ref: '#/components/schemas/SourcedAffiliation'
        ID:
          type: object
          description: >-
            Identity-associated fields such as passport numbers, driver's
            licenses, national IDs.
          additionalProperties:
            $ref: '#/components/schemas/SourcedString'
        documents:
          type: array
          description: >-
            References to digital documents found for this profile. May include
            corporate registry listings, court and legal documents, public
            securities filings (SEC), or open source investigation files.
          items:
            $ref: '#/components/schemas/UrlInfo'
        websites:
          type: array
          description: >-
            Websites that are owned by or describe this profile, including
            corporate websites, personal websites, and blogs.
          items:
            $ref: '#/components/schemas/SourcedString'
        notes:
          type: array
          description: Other unstructured transcripts associated with the profile.
          items:
            $ref: '#/components/schemas/SourcedString'
        checklist:
          $ref: '#/components/schemas/ProfileChecklist'
          description: >-
            Watchlist and risk screening states and sources. Contains hit status
            for each risk feed and detailed breakdown of hits.
        client_risk_rating:
          $ref: '#/components/schemas/ClientRiskRating'
          description: >-
            Customer Risk Rating (CRR) assessment based on discovered data.
            Provides overall risk score and contributing factors.
        sources:
          type: array
          description: List of source names that contributed data to this profile.
          items:
            type: string
          example:
            - OFAC SDN List
            - World Leaders Database
            - Reuters
        source_details:
          type: array
          description: >-
            Details and metadata associated with the sources that contributed
            data to this profile.
          items:
            $ref: '#/components/schemas/SourceDetailElement'
        score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            The Criteria Match Score: a normalized value between 0 and 1 that
            represents the match to the search parameters. 1.0 = exact match,
            0.8-0.99 = partial match, < 0.79 = low confidence match.
          example: 0.95
        match_score_info:
          $ref: '#/components/schemas/MatchScoreInfo'
          description: >-
            Detailed breakdown of the Criteria Match Score for each field
            provided in the search parameters.
        review_status:
          type: string
          description: >-
            The review status of the potential match. `Profile` and
            `StoredPotentialMatch` each list the values it can take.
        automatic_disposition:
          $ref: '#/components/schemas/DispositionAnnotation'
          description: >-
            Present only when Automatic Disposition auto-dispositioned this
            potential match (Full Auto Mode for the Direct API channel) and set
            `review_status`. Only screened matches, meaning those with at least
            one flagged feed in `checklist.screen`, are analyzed. Clean matches
            and workspaces without the feature enabled never carry this field.
        disposition_hint:
          $ref: '#/components/schemas/DispositionAnnotation'
          description: >-
            Present when the workspace runs an Automatic Disposition outcome in
            Hint Mode, or when the analysis completed without meeting the
            configured confidence threshold (an `undetermined` prediction).
            Advisory only: `review_status` stays `unresolved`, and the
            annotation is for the integration to interpret in real time. Only
            screened matches, meaning those with at least one flagged feed in
            `checklist.screen`, are analyzed. Clean matches and workspaces
            without the feature enabled never carry this field.
        suppression_reason:
          type: string
          enum:
            - no_material_change
            - allowlist
          description: >-
            Present only when `review_status` is `suppressed`, and records why
            Minerva suppressed the match. Any later status change clears it. Set
            by the server: a status update that supplies it returns `400`. A
            suppressed match stored without a reason is returned as
            `no_material_change`.
          example: allowlist
        allowlist:
          $ref: '#/components/schemas/AllowlistAnnotation'
        custom_list:
          $ref: '#/components/schemas/CustomListProvenance'
        reportURL:
          type: string
          description: >-
            URL to the generated PDF report for this profile, if one has been
            generated.
          example: https://storage.googleapis.com/...
      required:
        - type
        - name
        - sources
        - source_details
    SourcedName:
      type: object
      description: >-
        Schema for a name, with structured first and last name components and
        source lineage.
      properties:
        value:
          type: string
          description: >-
            The last name (for individuals) or full company name (for
            organizations).
          example: Smith
        first:
          $ref: '#/components/schemas/SourcedString'
          description: For individuals only, the first name with source lineage.
        other_names:
          type: array
          description: Middle names, initials, prefixes, and suffixes.
          items:
            $ref: '#/components/schemas/SourcedString'
        sources:
          type: array
          description: Source lineage for the last name or full company name.
          items:
            $ref: '#/components/schemas/SourcedStringSource'
        inferred:
          type: boolean
          description: >-
            Indicates whether the value was inferred algorithmically (true) or
            reported directly from the source.
          example: false
        reputation_score:
          type: integer
          minimum: 0
          maximum: 10
          description: Score from 0-10 indicating the reputation of the source.
          example: 8
        trusted:
          type: boolean
          description: >-
            Reports whether the reputation score is at or above the threshold
            for trusted status.
          example: true
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Score from 0.0-1.0 indicating the closeness of the match between the
            search criteria and this name. On an entry of a profile's `aliases`
            array this is that alias's own score, so entries in one array
            normally differ. Do not read `match_score_info.aliases` as a summary
            of this array: that value is the aggregate maximum retained as the
            record's ranking input, and it is not recomputed when the alias list
            changes, so it can differ from the largest `match_score` present
            here.
          example: 0.98
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: Label associated with the match score.
        matched_query:
          type: boolean
          description: >-
            Present and true on at most one entry of a profile's `aliases`
            array: the alias whose own text matched the search criteria strictly
            better than the profile's primary name. Omitted entirely otherwise,
            including when the primary name matched at least as well, so its
            absence means no alias out-matched the displayed name. Unrelated to
            `is_best_match` on a source entry, which is a source-consensus
            tiebreaker and says nothing about the search criteria. Derived from
            this array's own scores rather than from `match_score_info.aliases`,
            so it may be set on a record whose aggregate alias score is lower
            than this entry's `match_score`.
          example: true
      required:
        - value
    SourcedGender:
      type: object
      description: >-
        A sourced gender object containing the gender value and source lineage.
        Gender is normalized to "Male", "Female", "Other", or "Unknown".
      properties:
        value:
          type: string
          description: The gender value, normalized to Male, Female, Other, or Unknown.
          enum:
            - Male
            - Female
            - Other
            - Unknown
          example: Male
        sources:
          type: array
          description: Array of source lineage objects for this gender field.
          items:
            $ref: '#/components/schemas/SourcedStringSource'
        inferred:
          type: boolean
          description: >-
            Indicates whether the value was inferred algorithmically (true) or
            reported directly from the source.
          example: false
        reputation_score:
          type: integer
          minimum: 0
          maximum: 10
          description: Score from 0-10 indicating the reputation of the source.
          example: 7
        trusted:
          type: boolean
          description: >-
            Reports whether the reputation score is at or above the threshold
            for trusted status.
          example: true
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Score from 0.0-1.0 indicating the closeness of the match between the
            search criteria and this gender value.
          example: 1
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: Label associated with the match score.
      required:
        - value
    SourcedString:
      type: object
      description: >-
        A sourced string object with a consensus value and its source lineage.
        Minerva applies entity resolution to consolidate data from multiple
        sources, keeping the original source values and scores in the lineage.
      properties:
        value:
          type: string
          description: >-
            The consensus value that best represents the combination of source
            values discovered during the automated investigation.
          example: Software Engineer
        sources:
          type: array
          description: >-
            Array of source lineage objects containing information about each
            source that reported data for this field.
          items:
            $ref: '#/components/schemas/SourcedStringSource'
        timestamp:
          $ref: '#/components/schemas/DateObject'
          description: The timestamp associated with the data.
        inferred:
          type: boolean
          description: >-
            Indicates whether the value was inferred algorithmically (true) or
            reported directly from the source.
          example: false
        reputation_score:
          type: integer
          minimum: 0
          maximum: 10
          description: >-
            Score from 0-10 indicating the general reputation and
            trustworthiness of the consensus value. A value of 7 or above
            indicates "trusted" status.
          example: 8
        trusted:
          type: boolean
          description: >-
            Indicates whether the value is likely to be ground truth. True when
            `reputation_score` is 7 or above.
          example: true
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Score from 0.0-1.0 indicating the closeness of the match between the
            search criteria and this field value.
          example: 0.95
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: Label associated with the match score.
        tag:
          type: string
          description: >-
            Additional label to assign the sourced string such as a social media
            platform.
          example: LinkedIn
      required:
        - value
    SourcedDate:
      type: object
      description: >-
        A sourced date object containing a consensus date value and source
        lineage for dates like date of birth or date of incorporation.
      properties:
        value:
          $ref: '#/components/schemas/DateObject'
          description: The consensus date value.
        sources:
          type: array
          description: Array of source lineage objects for this date field.
          items:
            $ref: '#/components/schemas/SourcedDateSource'
        inferred:
          type: boolean
          description: >-
            Indicates whether the value was inferred algorithmically (true) or
            reported directly from the source.
          example: false
        reputation_score:
          type: integer
          minimum: 0
          maximum: 10
          description: >-
            Score from 0-10 indicating the general reputation and
            trustworthiness of the consensus value.
          example: 9
        trusted:
          type: boolean
          description: >-
            Indicates whether the information is likely to be a ground truth,
            trusted value.
          example: true
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Score from 0.0-1.0 indicating the closeness of the match between the
            search criteria and this date value.
          example: 1
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: Label associated with the match score.
      required:
        - value
    ProfileContact:
      type: object
      description: >-
        Contact information for the profile including email addresses and phone
        numbers.
      properties:
        email:
          type: array
          description: List of email addresses known for this profile.
          items:
            $ref: '#/components/schemas/SourcedString'
        phone:
          type: array
          description: >-
            List of phone numbers known for this profile. Not guaranteed to be
            in E.164 format.
          items:
            $ref: '#/components/schemas/SourcedString'
    ProfileMedia:
      type: object
      description: >-
        Media for the profile, including adverse and neutral media URLs and
        social media accounts. Present when the News, Open Source, or Social
        Media feeds are included.
      properties:
        risk_urls:
          type: array
          description: >-
            URLs that contain relevant AML/financial crimes risk. Articles here
            are negative in sentiment and associated with one or more of the 28
            financial crimes risk categories.
          items:
            $ref: '#/components/schemas/UrlInfo'
        neutral_urls:
          type: array
          description: >-
            URLs that do not contain relevant AML/financial crimes risk.
            Articles here are not negative in sentiment and not associated with
            financial crimes risk categories.
          items:
            $ref: '#/components/schemas/UrlInfo'
        usernames:
          type: array
          description: >-
            Social media accounts that the deep learning investigation model
            associated with this profile. Present when the Open Source or Social
            Media feeds are included.
          items:
            $ref: '#/components/schemas/ProfileSocialUsername'
    SourcedAffiliation:
      type: object
      description: >-
        Schema for an individual, organization, or concept linked to a profile,
        such as family connections, ownership records, or employee records.
      properties:
        value:
          type: string
          description: >-
            The subject that this affiliation describes, such as a person,
            organization, or concept.
          example: Acme Corporation
        type:
          $ref: '#/components/schemas/SourcedString'
          description: >-
            The way that the source is affiliated with the subject, such as
            "Father", "Shareholder", or "Chief Financial Officer".
        sources:
          type: array
          description: Source lineage for the affiliation.
          items:
            $ref: '#/components/schemas/SourcedStringSource'
        inferred:
          type: boolean
          description: >-
            Indicates whether the value was inferred algorithmically (true) or
            reported directly from the source.
          example: false
        reputation_score:
          type: integer
          minimum: 0
          maximum: 10
          description: Score from 0-10 indicating the reputation of the source.
          example: 8
        trusted:
          type: boolean
          description: >-
            Reports whether the reputation score is at or above the threshold
            for trusted status.
          example: true
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Score from 0.0-1.0 indicating the closeness of the match between the
            search criteria and this affiliation.
          example: 0.85
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: Label associated with the match score.
      required:
        - value
    UrlInfo:
      type: object
      description: >-
        URL link object with title, source information, and risk classification.
        Used for documents, news articles, and other web references.
      properties:
        url:
          type: string
          format: uri
          description: The URL of the document or article.
          example: https://www.bbc.com/news/article-123
        title:
          type: string
          description: The title of the document or article.
          example: 'Breaking News: Major Development'
        source_name:
          type: string
          description: The name of the source that published the content.
          example: BBC News
        snippet:
          type: string
          description: >-
            Small snippet of text from the article, up to 2000 characters.
            Provides context without requiring full article access.
          example: The individual was mentioned in connection with...
        language:
          type: string
          description: ISO2 code of the language of the text, or blank if unknown.
          example: en
        flags:
          type: object
          description: >-
            Risk and sentiment classification flags from deep learning inference
            on the article text.
          properties:
            sentiment:
              type: array
              description: >-
                Sentiment classification with confidence level. Values include
                "Positive", "Neutral", or "Negative" followed by confidence
                (Low/Medium/High).
              items:
                type: string
              example:
                - Negative (High)
            risk:
              type: array
              description: >-
                One or more of 28 different types of financial crimes risk, with
                confidence level. Examples: "Money Laundering (High)",
                "Fraud/Bribery/Corruption (Medium)", "Other (Non-Financial)
                (Low)".
              items:
                type: string
              example:
                - Money Laundering (High)
                - Fraud/Bribery/Corruption (Medium)
        http_status_code:
          type: integer
          description: >-
            The HTTP status received by the test probe to determine content
            availability.
          example: 200
        date_time_published:
          type: string
          description: Datetime string of when the article was published. Empty if unknown.
          example: '2024-01-15T10:30:00Z'
      required:
        - url
        - title
    ProfileChecklist:
      type: object
      description: >-
        Watchlist and risk screening states and sources. Contains the hit status
        for various risk feeds and detailed breakdown of each hit.
      properties:
        screen:
          $ref: '#/components/schemas/FeedScreen'
          description: Hit status for each feed (true for hit, false for clear).
        hits:
          $ref: '#/components/schemas/FeedHits'
          description: Lists of sources that Minerva found as hits for each feed.
        hits_info:
          type: array
          description: >-
            Detailed breakdown of hits with original source values and match
            scores for each attribute.
          items:
            $ref: '#/components/schemas/ScreeningHitInfo'
      required:
        - screen
        - hits
        - hits_info
    ClientRiskRating:
      type: object
      description: >-
        Customer Risk Rating (CRR) assessment on the profile based on discovered
        data. Provides overall risk score and breakdown of contributing factors.
      properties:
        score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            The customer risk rating score, normalized from 0.0-1.0. Higher
            values indicate higher risk.
          example: 0.75
        label:
          type: string
          enum:
            - High
            - Medium
            - Low
            - None
          description: The risk rating label associated with the score.
          example: High
        factors:
          type: array
          description: >-
            List of criteria factors with their weights and values that comprise
            the total CRR analysis.
          items:
            $ref: '#/components/schemas/ClientRiskRatingFactor'
      required:
        - score
        - label
        - factors
    SourceDetailElement:
      type: object
      description: Metadata about a source providing additional information.
      properties:
        name:
          type: string
          description: The name of the source.
          example: OFAC SDN List
        source_feed:
          type: string
          description: The screening feed the source is associated with.
          example: Sanctions
        flagged_feeds:
          type: array
          description: The screening feeds that the source flagged.
          items:
            type: string
          example:
            - Sanctions
            - PEP
        urls:
          type: array
          description: URLs associated with the source.
          items:
            $ref: '#/components/schemas/UrlInfo'
        description:
          type: string
          description: Description of the source or explanation of why it has no URLs.
          example: Official US Treasury sanctions database
        inferences:
          type: array
          description: Inferences made from the source.
          items:
            $ref: '#/components/schemas/SourceDetailInference'
      required:
        - name
        - source_feed
        - flagged_feeds
        - urls
        - description
        - inferences
    MatchScoreInfo:
      type: object
      description: >-
        Detailed breakdown of the Criteria Match Score for each field provided
        in the search parameters.
      additionalProperties:
        $ref: '#/components/schemas/MatchScoreInfoField'
      example:
        name:
          score: 0.98
          criteria_match_level: exact
          verified: true
        country:
          score: 0.85
          criteria_match_level: close
          verified: true
    DispositionAnnotation:
      type: object
      description: >-
        AI disposition annotation produced by [Automatic
        Disposition](/automatic-disposition-guide) analysis for a screened
        potential match. Returned as `automatic_disposition` when workspace
        policy allowed the prediction to set `review_status` (Full Auto Mode),
        or as `disposition_hint` when the analysis is advisory only (Hint Mode,
        or a completed analysis that did not reach the configured confidence
        threshold). Both fields are omitted for matches screened without
        automatic disposition.
      properties:
        prediction:
          type: string
          enum:
            - true_positive
            - false_positive
            - undetermined
          description: >-
            Model disposition for the potential match against the searched
            subject. `undetermined` appears only on `disposition_hint`, when the
            analysis completed without reaching a configured confidence
            threshold.
          example: false_positive
        confidence:
          type: number
          minimum: 0
          maximum: 1
          description: Model confidence in the prediction.
          example: 0.95
        analysis_status:
          type: string
          enum:
            - completed
            - failed
          description: >-
            Whether the disposition analysis ran to completion for this match.
            When `failed`, the match is left `unresolved` for normal manual
            review.
          example: completed
        rationale:
          type: string
          description: >-
            Short natural-language explanation of the prediction for analyst
            review.
          example: >-
            The searched subject's occupation and country conflict with the
            listed person.
        evidence_refs:
          type: array
          description: >-
            References to the match payload fields and articles the model relied
            on.
          items:
            type: object
        score_summary:
          type: object
          description: Per-field score breakdown produced by the disposition analysis.
        risk_flags:
          type: array
          description: Risk signals the analysis surfaced while reviewing the evidence.
          items:
            type: string
        signature_version:
          type: string
          description: >-
            Automatic Disposition prompt/signature version used for the
            analysis.
        source:
          type: string
          description: >-
            Screening channel that produced the annotation. Always `direct_api`
            for Direct API searches.
          example: direct_api
        error:
          type: object
          description: >-
            Bounded error metadata, present only when the analysis could not
            complete cleanly for this match.
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
    AllowlistAnnotation:
      type: object
      description: >-
        How the workspace allowlist evaluated this match. Present when an entry
        accepted the screened subject (in any state) or a near miss exists;
        absent on uncovered hits and when `allowlist_summary.status` is `off` or
        `unavailable`. It is kept as history: a later status change does not
        remove it.
      properties:
        status:
          type: string
          enum:
            - suppressed
            - would_suppress
            - partially_covered
            - subject_not_matched
            - details_not_matched
            - record_not_covered
            - record_changed
            - entry_expired
            - entry_lifetime_exceeded
          description: >-
            `suppressed`: every alerting record is covered by a valid entry
            (Suppression Mode). `would_suppress`: the same coverage in Hint
            Mode; the match stays `unresolved`. The other values alert and
            explain why the entry did not apply: `partially_covered` (some
            records not covered), `subject_not_matched` (the screened name was
            not accepted), `details_not_matched` (a detail such as date of birth
            differs), `record_not_covered` (a record outside the entry's known
            records), `record_changed` (the watchlist record changed since it
            was captured or pinned), `entry_expired` and
            `entry_lifetime_exceeded`.
          example: suppressed
        mode:
          type: string
          enum:
            - hint
            - suppress
        list:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            version_id:
              type: string
            version_sequence:
              type: integer
        entries:
          type: array
          items:
            $ref: '#/components/schemas/AllowlistAnnotationEntry'
        matched_on:
          type: object
          properties:
            match_rules:
              type: object
              properties:
                level:
                  type: string
                  enum:
                    - exact
                    - standard
                    - tolerant
                source:
                  type: string
                  enum:
                    - workspace
                    - entry
                    - workspace_clamped
                    - sanctions_cap
            subject_match:
              type: object
              description: Present when a name was accepted.
              properties:
                tier:
                  type: string
                  enum:
                    - exact
                    - standard
                    - tolerant
                key:
                  type: string
                score:
                  type: number
            comparison:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                    enum:
                      - name
                      - entity_type
                      - date_of_birth
                      - date_of_incorporation
                      - country
                      - company_number
                      - national_id
                      - customer_id
                  entry: {}
                  screened: {}
                  result:
                    type: string
                    enum:
                      - same
                      - different
                      - within_tolerance
                      - missing_on_screen
                      - not_compared
            records_covered:
              type: integer
            records_total:
              type: integer
        screened_name_is_record:
          type: boolean
          description: >-
            Present (`true`) when the screened name is itself the listed party's
            name, so the entry was not applied.
        record_not_covered_reason:
          type: string
          enum:
            - new_record
            - ambiguous_first_sighting
        near_miss_count:
          type: integer
          description: >-
            Present when greater than 0: entries that cover the record for a
            different customer.
        near_misses:
          type: array
          items:
            type: object
            properties:
              record_uid:
                type: string
              name:
                type: string
              reason:
                type: string
                enum:
                  - covered_for_different_customer
        decided_by:
          type: string
          enum:
            - stage
            - analyst
            - application
          description: >-
            `stage` for screening; `analyst` or `application` when `POST
            /v2/allowlist/resolve` applied the entry.
        decided_by_actor:
          type: object
          description: Resolve only.
          properties:
            id:
              type: string
            name:
              type: string
        evaluated_at:
          type: string
          format: date-time
      required:
        - status
        - mode
        - list
        - matched_on
        - decided_by
        - evaluated_at
      example:
        status: suppressed
        mode: suppress
        list:
          id: LIST_ID
          name: Cleared payees
          version_id: VERSION_ID
          version_sequence: 1
        entries:
          - record_uid: al_ENTRY_UID
            name: NatWest Bank
            entity_type: organization
            scope: known_records
            covers:
              - category: sanctions
                source: OFAC SDN
                record_name: Natwest Logistics LLC
                fingerprint_source: pinned
            reason: Cleared by compliance. Ticket COMP-2291.
            added_by:
              type: application
              id: app_APPLICATION_ID
              name: Payments sync
            added_at: '2026-11-18T16:06:28Z'
            expires_at: '2027-01-15T00:00:00Z'
        matched_on:
          match_rules:
            level: exact
            source: workspace
          subject_match:
            tier: exact
            key: full_norm
            score: 1
          comparison:
            - field: name
              entry: NatWest Bank
              screened: NatWest Bank
              result: same
            - field: entity_type
              entry: organization
              screened: organization
              result: same
          records_covered: 1
          records_total: 1
        decided_by: stage
        evaluated_at: '2026-11-18T16:07:13Z'
    CustomListProvenance:
      type: object
      description: >-
        Present on a match from one of your custom lists (for example an
        Internal hit). Join on `recordUid`, your own record ID.
      properties:
        customListBacked:
          type: boolean
        isCustomList:
          type: boolean
        listId:
          type: string
        listVersionId:
          type: string
        listName:
          type: string
          example: Offboarded clients
        feedCategory:
          type: string
          example: internal
        recordUid:
          type: string
          example: CRM-10442
        matchedVariant:
          type: string
          description: The name or alias of the record that matched.
        customFields:
          type: object
          additionalProperties:
            type: string
          description: >-
            The record's `custom_fields`, when it has any. Also returned in
            `other_fields.custom_fields`.
    SourcedStringSource:
      type: object
      description: >-
        Single unit of data lineage for a sourced string value. Each source
        contributes to the value consensus.
      allOf:
        - $ref: '#/components/schemas/SourceFields'
        - type: object
          properties:
            value:
              type: string
              description: The value reported by this source.
              example: John Smith
          required:
            - value
    CriteriaMatchLevel:
      type: string
      enum:
        - exact
        - close
        - loose
        - none
      description: >-
        Label for a match score that describes how close the match is.
        Thresholds: exact (>= 0.98), close (>= 0.85), loose (>= 0.75), none (<
        0.75).
      example: close
    DateObject:
      type: object
      description: A date object containing year, month, and day components.
      properties:
        year:
          type: integer
          description: >-
            The year component of the date. Always present when the date is
            known. A 4 digit integer for a calendar year.
          example: 1984
        month:
          type: integer
          minimum: 1
          maximum: 12
          description: >-
            The integer corresponding to the calendar month (1-12). May not be
            present if the month is not known.
          example: 6
        day:
          type: integer
          minimum: 1
          maximum: 31
          description: >-
            The integer corresponding to the calendar day. May not be present if
            the day is not known.
          example: 15
      required:
        - year
    SourcedDateSource:
      type: object
      description: Single unit of data lineage for a sourced date value.
      allOf:
        - $ref: '#/components/schemas/SourceFields'
        - type: object
          properties:
            value:
              $ref: '#/components/schemas/DateObject'
              description: The date value reported by this source.
          required:
            - value
    ProfileSocialUsername:
      type: object
      description: >-
        Social media username associated with the profile, discovered through
        deep learning investigation.
      properties:
        value:
          type: string
          description: The social media username.
          example: john_smith_official
        tag:
          type: string
          description: The name of the social media platform.
          example: Twitter
        sources:
          type: array
          description: Sources that contributed to the consensus value.
          items:
            $ref: '#/components/schemas/SourcedString'
      required:
        - value
    FeedScreen:
      type: object
      description: >-
        Hit status for each feed that was screened. True indicates a
        hit/finding, false indicates clear/no hits.
      properties:
        Sanctions:
          type: boolean
          description: >-
            True if the profile is listed on an international sanctions list
            (OFAC SDN, HMT, OSFI Consolidated, and others).
        PEP:
          type: boolean
          description: >-
            True if profile is a domestic PEP, foreign PEP, RCA of a PEP, head
            of a state-owned corporation, or HIO.
        Criminal:
          type: boolean
          description: >-
            True if profile is determined to be a criminal actor based on
            watchlists (e.g., FBI Terrorism List) or inference.
        Legal:
          type: boolean
          description: True if profile has high risk legal cases involving it.
        News:
          type: boolean
          description: >-
            True if profile has high risk adverse media articles (negative
            sentiment + adverse media risk categories).
        Open Source:
          type: boolean
          description: True if open source investigation found relevant hits.
        Social Media:
          type: boolean
          description: True if social media investigation found relevant hits.
        Registries:
          type: boolean
          description: True if corporate registry searches found relevant hits.
        Ownership:
          type: boolean
          description: True if ownership/beneficial ownership searches found relevant hits.
        Offshore:
          type: boolean
          description: True if offshore entity databases found relevant hits.
    FeedHits:
      type: object
      description: >-
        Lists of source names that were hit for each feed. Only present for
        feeds where screen value is true.
      properties:
        Sanctions:
          type: array
          items:
            type: string
          example:
            - OFAC SDN List
            - EU Consolidated List
        PEP:
          type: array
          items:
            type: string
          example:
            - World Leaders Database
        Criminal:
          type: array
          items:
            type: string
          example:
            - FBI Most Wanted
        Legal:
          type: array
          items:
            type: string
          example:
            - PACER
        News:
          type: array
          items:
            type: string
          example:
            - Reuters
            - BBC News
        Open Source:
          type: array
          items:
            type: string
        Social Media:
          type: array
          items:
            type: string
        Registries:
          type: array
          items:
            type: string
        Ownership:
          type: array
          items:
            type: string
        Offshore:
          type: array
          items:
            type: string
    ScreeningHitInfo:
      type: object
      description: >-
        Detailed breakdown of a screening hit, with original source values and
        match scores for each attribute. Helps distinguish potential match
        identifiers across risk sources.
      properties:
        source:
          type: string
          description: The name of the source that this hit was triggered from.
          example: OFAC SDN List
        feed:
          type: string
          description: The Minerva data feed that the source belongs to.
          enum:
            - Sanctions
            - PEP
            - News
            - Legal
            - Criminal
          example: Sanctions
        name:
          $ref: '#/components/schemas/ScreeningHitInfoField'
          description: Match attributes of the name that was hit upon from this source.
        occupation:
          $ref: '#/components/schemas/ScreeningHitInfoField'
          description: >-
            The job title reported by the hit source. Present for individual
            profiles only. Match score is 0.0 if not provided in search
            parameters.
        organization:
          $ref: '#/components/schemas/ScreeningHitInfoField'
          description: >-
            The organization reported by the hit source. Present for individual
            profiles only. Match score is 0.0 if not provided in search
            parameters.
        nationality:
          $ref: '#/components/schemas/ScreeningHitInfoField'
          description: >-
            The nationality reported by the hit source. Match score is 0.0 if
            country not provided in search parameters.
        date:
          $ref: '#/components/schemas/ScreeningHitInfoField'
          description: >-
            The date reported by the hit source (format: YYYY-MM-DD, YYYY, or
            YYYY-MM). Match score is 0.0 if date not provided in search
            parameters.
        locations:
          type: array
          description: >-
            Locations reported by the hit source. May contain address, city,
            state, or country. The match score is 0.0 when the search parameters
            contain no location.
          items:
            $ref: '#/components/schemas/ScreeningHitInfoField'
        allowlist:
          $ref: '#/components/schemas/AllowlistHitElement'
      required:
        - source
        - feed
        - name
    ClientRiskRatingFactor:
      type: object
      description: >-
        A single factor that contributed to an overall client risk rating (CRR)
        score.
      properties:
        weight:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            The weight applied to the value when creating the consolidated
            weighted score.
          example: 0.15
        value:
          type: number
          minimum: 0
          maximum: 1
          description: The value of the factor calculated, before weighting was applied.
          example: 0.8
        code:
          type: integer
          description: >-
            Primary key mapping of the factor to the total list of possible
            criteria. Guaranteed to remain the same over time.
          example: 1
        label:
          type: string
          description: >-
            Human-readable context about what this factor represents in the
            weighting scheme.
          example: Sanctions List
        annotation:
          type: string
          description: >-
            Additional notes providing further description about the factor
            value.
          example: Listed on OFAC SDN
      required:
        - weight
        - value
        - code
        - label
    SourceDetailInference:
      type: object
      description: >-
        Details regarding an inference made from a source, such as PEP or
        Criminal inference.
      properties:
        feed:
          type: string
          description: The screening feed that the inference flagged for.
          example: PEP
        reason:
          type: string
          description: The reason the inference was made.
          example: Matched regex pattern for political position
        url:
          type: string
          description: URL linking to the source of the inference data.
          example: https://example.com/article
        field:
          type: string
          description: The field the inference was made on.
          example: Notes
        context:
          type: string
          description: Snippet of text providing context for the inference.
          example: The individual served as Minister of...
      required:
        - feed
        - reason
        - url
        - field
        - context
    MatchScoreInfoField:
      type: object
      description: Match score information for a single search parameter field.
      properties:
        score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Match score from 0.0-1.0 where 1.0 represents a perfect match and
            0.0 represents no match.
          example: 0.95
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: >-
            String label corresponding to the score: "exact" (>= 0.98), "close"
            (>= 0.85), "loose" (>= 0.75), "none" (< 0.75).
        verified:
          type: boolean
          description: >-
            True if the match meets verification requirements: source
            reputation_score >= 7 (trusted) AND criteria_match_level is at least
            "close".
          example: true
      required:
        - score
        - criteria_match_level
        - verified
    AllowlistAnnotationEntry:
      type: object
      description: >-
        A snapshot of the allowlist entry that decided the outcome, taken from
        the published version. Customer IDs are never echoed.
      properties:
        record_uid:
          type: string
          description: The entry's `al_…` uid in the custom list.
          example: al_be8ed741b581485c4d5668ee
        name:
          type: string
          example: NatWest Bank
        aliases:
          type: array
          items:
            type: string
        entity_type:
          type: string
          enum:
            - individual
            - organization
            - unknown
        date_of_birth:
          type: string
        date_of_incorporation:
          type: string
        countries:
          type: array
          items:
            type: string
        identifiers:
          type: object
          additionalProperties:
            type: string
        scope:
          type: string
          enum:
            - known_records
            - source
            - category
        covers:
          type: array
          description: 'For `known_records` entries: the watchlist records the entry covers.'
          items:
            type: object
            properties:
              category:
                type: string
                example: sanctions
              source:
                type: string
                example: OFAC SDN
              record_name:
                type: string
                example: Natwest Logistics LLC
              fingerprint_source:
                type: string
                enum:
                  - captured
                  - pinned
                  - none
                description: >-
                  `captured`: the record's content was captured from a match.
                  `pinned`: pinned at the first covering screen. `none`: not
                  pinned yet.
        sources:
          type: array
          items:
            type: string
        categories:
          type: array
          items:
            type: string
        reason:
          type: string
        added_by:
          type: object
          properties:
            type:
              type: string
              enum:
                - user
                - application
            id:
              type: string
            name:
              type: string
        added_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        review_by:
          type: string
    SourceFields:
      type: object
      description: Fields that are shared by all source lineage records.
      properties:
        source:
          type: string
          description: The human readable name of the source.
          example: OFAC SDN List
        feed:
          type: string
          description: >-
            The Minerva data feed this source belongs to. One of the supported
            Minerva data feeds.
          enum:
            - Internal
            - Sanctions
            - PEP
            - Criminal
            - Legal
            - Offshore
            - Ownership
            - Registries
            - Social Media
            - News
            - Open Source
          example: Sanctions
        timestamp:
          $ref: '#/components/schemas/DateObject'
          description: >-
            The timestamp associated with when the data was collected or
            reported.
        inferred:
          type: boolean
          description: >-
            Indicates whether the value was inferred algorithmically (true) or
            reported directly from the source. Inferred values are down-weighted
            in the consensus algorithm.
          example: false
        reputation_score:
          type: integer
          minimum: 0
          maximum: 10
          description: >-
            Score from 0-10 indicating the reputation of the source. A value of
            7 or above indicates "trusted" status where the source is highly
            accredited.
          example: 8
        trusted:
          type: boolean
          description: >-
            Reports whether the reputation score is at or above the threshold
            (7) for the source to be considered trusted.
          example: true
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Score from 0.0-1.0 indicating the closeness of the match between the
            search criteria and this source value.
          example: 0.92
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: Label associated with the match score.
        is_best_match:
          type: boolean
          description: >-
            Present and true on the source entry whose assertion won the value
            consensus for this field, i.e. the source that supplied the
            displayed value. Omitted entirely otherwise. This is a
            source-consensus tiebreaker and says nothing about the search
            criteria: for "which name did the query actually match", see
            `matched_query` on an entry of a profile's `aliases` array.
          example: true
    ScreeningHitInfoField:
      type: object
      description: >-
        Information about the match for a single field from a potential
        screening hit.
      properties:
        value:
          type: string
          description: The value of the field that was matched.
          example: John Smith
        match_score:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            The computed match score between the query parameter and the
            original source value.
          example: 0.95
        criteria_match_level:
          $ref: '#/components/schemas/CriteriaMatchLevel'
          description: The label associated with the match score.
      required:
        - value
        - match_score
        - criteria_match_level
    AllowlistHitElement:
      type: object
      description: >-
        The allowlist outcome for one hit element. The match-level
        `allowlist.status` and `allowlist.mode` say whether the coverage acted;
        this element status never uses `would_suppress`.
      properties:
        status:
          type: string
          enum:
            - suppressed
            - partially_covered
            - subject_not_matched
            - details_not_matched
            - record_not_covered
            - record_changed
            - entry_expired
            - entry_lifetime_exceeded
        record_uid:
          type: string
        record_fingerprint:
          type: string
      required:
        - status
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        The Minerva API key used for this integration. Manage API keys in the
        Minerva dashboard under Administration > Developers.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.