> ## 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.

# Capture a match for an allowlist entry

> Read-only. Returns the screened subject of a potential match and, for each non-Internal watchlist record on it, the identity and content fingerprint an allowlist entry can cover, plus the live entries that already cover it. Most integrations call the Admin API's `POST /custom-lists/v2/organizations/{orgId}/{listId}/records/from-match` instead, which captures, saves and resolves in one step.

Requires `x-workspace-id` and an **Admin (tenant-wide)** application key of the same tenant, or a dashboard owner or admin. Any other key returns `403`. A match in another tenant or workspace returns `404`.



## OpenAPI

````yaml /api-reference/core.json get /v2/allowlist/match-capture/{match_id}
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/allowlist/match-capture/{match_id}:
    get:
      tags:
        - Allowlists
      summary: Capture a match for an allowlist entry
      description: >-
        Read-only. Returns the screened subject of a potential match and, for
        each non-Internal watchlist record on it, the identity and content
        fingerprint an allowlist entry can cover, plus the live entries that
        already cover it. Most integrations call the Admin API's `POST
        /custom-lists/v2/organizations/{orgId}/{listId}/records/from-match`
        instead, which captures, saves and resolves in one step.


        Requires `x-workspace-id` and an **Admin (tenant-wide)** application key
        of the same tenant, or a dashboard owner or admin. Any other key returns
        `403`. A match in another tenant or workspace returns `404`.
      parameters:
        - name: match_id
          in: path
          required: true
          description: The potential match `id`.
          schema:
            type: string
        - name: x-workspace-id
          in: header
          required: true
          description: The workspace the match belongs to. It is never inferred.
          schema:
            type: string
      responses:
        '200':
          description: The capture.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowlistMatchCapture'
        '400':
          description: '`x-workspace-id` is missing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowlistApiError'
        '401':
          description: Missing or invalid credential.
        '403':
          description: >-
            The key is not an Admin (tenant-wide) application key of this
            tenant, or the user is not an owner or admin.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowlistApiError'
        '404':
          description: The match is not in this tenant and workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowlistApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    AllowlistMatchCapture:
      type: object
      properties:
        match_id:
          type: string
        workspace_id:
          type: string
        subject:
          type: object
          description: >-
            The screened subject from the stored search. Keys are always
            present, `null` when not screened.
          properties:
            name:
              type: string
              nullable: true
            entity_type:
              type: string
              nullable: true
            date:
              type: string
              nullable: true
            country:
              type: string
              nullable: true
              description: >-
                The screened subject's country as the engine's display label
                (e.g. 'Congo' for CG). For display only: it is not an ISO code
                and must not be mapped back to one.
            country_code:
              type: string
              nullable: true
              description: >-
                ISO 3166-1 alpha-2 code of the submit-time country identity
                bound to this subject, or null when no country was submitted or
                the identity cannot be proven (e.g. requests stored before
                country binding). Use this, not country, to pre-fill an
                allowlist entry's countries.
            reg_id:
              type: string
              nullable: true
            personal_id:
              type: string
              nullable: true
            profile_id:
              type: string
              nullable: true
            external_id:
              type: string
              nullable: true
        elements:
          type: array
          description: One per suppressible hit element. Internal elements are excluded.
          items:
            type: object
            properties:
              index:
                type: integer
              category:
                type: string
              source:
                type: string
              record_name:
                type: string
              record_key:
                type: string
              fingerprint:
                type: string
              record_aliases:
                type: array
                items:
                  type: string
              covered_by:
                type: array
                description: Live entries in this workspace that already cover the element.
                items:
                  type: object
                  properties:
                    list_id:
                      type: string
                    record_uid:
                      type: string
      example:
        match_id: m_5b1c
        workspace_id: ws_payee
        subject:
          name: NATWEST BANK PLC
          entity_type: organization
          date: null
          country: United Kingdom
          country_code: GB
          reg_id: null
          personal_id: null
          profile_id: null
          external_id: payee-88213
        elements:
          - index: 0
            category: sanctions
            source: OFAC SDN
            record_name: Natwest Logistics LLC
            record_key: "sanctions\x1Fofac sdn\x1Fnatwest logistics llc"
            fingerprint: >-
              sha256:9341f26c078565780b5157f527395fb0bb82fc7f45e36a44aa871c579d5c97da
            record_aliases:
              - NWL LLC
              - Natwest Logistics
            covered_by: []
    AllowlistApiError:
      type: object
      properties:
        status:
          type: integer
          example: 400
        code:
          type: string
          example: error/bad-request
        message:
          type: string
        reason:
          type: string
          description: >-
            Present for allowlist-specific cases, for example
            `resolve_requires_live_entry`.
          example: resolve_requires_live_entry
      required:
        - status
        - code
        - message
  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.