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

# Add a customer to an allowlist from a match

> Adds the screened customer of a potential match to an allowlist and covers the match's records as captured, so a later change to a record alerts again (`record_changed`). Optionally publishes the list and marks the match, and the profile's other open matches the entry covers, `suppressed` with `suppression_reason: allowlist`.

Order: authorize; read the match capture; check the workspace's `allowlist` scope and match rules and the listed-party guard; when `resolve_match` is `true` and `publish` is `false`, require the entry to be live (`resolve_requires_live_entry`, nothing written); write the entry; publish when asked; resolve. A stale `expected_revision` returns `409 conflict` and the entry stays in the working set. A match the entry cannot mark yet, because the version the entry is in is not yet readable by screening or the list's live version changed while the request ran, is reported in `skipped[]` with `not_live_yet`, never as an error. The entry is saved.

Requires an admin API key, the **Admin (tenant-wide)** key type, which only an owner or admin of this organization can create. With `x-user-token`, the user must be an owner or admin.



## OpenAPI

````yaml /api-reference/admin-api.json post /custom-lists/v2/organizations/{orgId}/{listId}/records/from-match
openapi: 3.0.0
info:
  version: 1.0.0
  title: MinervaAI Admin API
  description: Admin endpoints for the Minerva application suite.
servers:
  - url: https://api.gominerva.com
    description: The production API server for Minerva.
security:
  - ApiKeyAuth: []
tags: []
paths:
  /custom-lists/v2/organizations/{orgId}/{listId}/records/from-match:
    post:
      tags:
        - Custom Lists
      summary: Add a customer to an allowlist from a match
      description: >-
        Adds the screened customer of a potential match to an allowlist and
        covers the match's records as captured, so a later change to a record
        alerts again (`record_changed`). Optionally publishes the list and marks
        the match, and the profile's other open matches the entry covers,
        `suppressed` with `suppression_reason: allowlist`.


        Order: authorize; read the match capture; check the workspace's
        `allowlist` scope and match rules and the listed-party guard; when
        `resolve_match` is `true` and `publish` is `false`, require the entry to
        be live (`resolve_requires_live_entry`, nothing written); write the
        entry; publish when asked; resolve. A stale `expected_revision` returns
        `409 conflict` and the entry stays in the working set. A match the entry
        cannot mark yet, because the version the entry is in is not yet readable
        by screening or the list's live version changed while the request ran,
        is reported in `skipped[]` with `not_live_yet`, never as an error. The
        entry is saved.


        Requires an admin API key, the **Admin (tenant-wide)** key type, which
        only an owner or admin of this organization can create. With
        `x-user-token`, the user must be an owner or admin.
      parameters:
        - in: path
          name: orgId
          required: true
          schema:
            type: string
          description: >-
            The organization (tenant) id. Must equal the tenant of the admin
            key.
        - in: path
          name: listId
          required: true
          schema:
            type: string
          description: The custom list id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AllowlistFromMatchRequest'
            examples:
              publish-and-resolve:
                summary: Add the payee, publish, and mark the match.
                value:
                  match_id: 665f0d4c2d2f7c2b2f2f2f31
                  workspace_id: 64b1c0de00000000000000a2
                  record_uid: null
                  records: all_uncovered
                  name: NatWest Bank
                  aliases:
                    - NatWest
                  entity_type: organization
                  scope: known_records
                  match_rules: null
                  reason: Payee is NatWest Bank, the UK clearing bank
                  expires_at: '2027-11-14'
                  resolve_match: true
                  resolve_other_open_matches: false
                  create_separate: false
                  publish: true
                  expected_revision: 41
      responses:
        '200':
          description: 'OK: the covers were merged into an existing entry.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AllowlistFromMatchResponse'
                required:
                  - data
              examples:
                merged-not-live-yet:
                  summary: >-
                    Merged into an existing entry; the match could not be marked
                    yet.
                  value:
                    data:
                      entry:
                        record_uid: al_be8ed741b581485c4d5668ee
                        status: active
                        name: NatWest Bank
                        aliases:
                          - NatWest
                          - National Westminster Bank
                        entity_type: organization
                        countries:
                          - GB
                        scope: known_records
                        covers:
                          - category: sanctions
                            source: OFAC SDN
                            record_name: Natwest Logistics LLC
                            added_by:
                              type: user
                              id: u_8d1e
                              name: A. Analyst
                            added_at: '2026-11-14T10:02:00Z'
                        match_rules: null
                        reason: Payee is NatWest Bank, the UK clearing bank
                        expires_at: '2027-11-14T00:00:00Z'
                        added_by:
                          type: user
                          id: u_8d1e
                          name: A. Analyst
                        added_at: '2026-11-14T10:02:00Z'
                        custom_fields: {}
                      working_set_revision: 43
                      published_version_id: 7c6b5a4d-3e2f-4a1b-8c9d-0e1f2a3b4c5e
                      resolved_match_ids: []
                      skipped:
                        - match_id: 665f0d4c2d2f7c2b2f2f2f31
                          reason: not_live_yet
                      warnings: []
        '201':
          description: 'Created: a new entry was added.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AllowlistFromMatchResponse'
                required:
                  - data
              examples:
                created:
                  summary: New entry, published, match marked.
                  value:
                    data:
                      entry:
                        record_uid: al_be8ed741b581485c4d5668ee
                        status: active
                        name: NatWest Bank
                        aliases:
                          - NatWest
                        entity_type: organization
                        countries: []
                        scope: known_records
                        covers:
                          - category: sanctions
                            source: OFAC SDN
                            record_name: Natwest Logistics LLC
                            added_by:
                              type: user
                              id: u_8d1e
                              name: A. Analyst
                            added_at: '2026-11-14T10:02:00Z'
                            record_ref:
                              fingerprint: >-
                                sha256:9341f26c078565780b5157f527395fb0bb82fc7f45e36a44aa871c579d5c97da
                              record_aliases:
                                - NWL LLC
                                - Natwest Logistics
                        match_rules: null
                        reason: Payee is NatWest Bank, the UK clearing bank
                        expires_at: '2027-11-14T00:00:00Z'
                        added_by:
                          type: user
                          id: u_8d1e
                          name: A. Analyst
                        added_at: '2026-11-14T10:02:00Z'
                        custom_fields: {}
                      working_set_revision: 42
                      published_version_id: 7c6b5a4d-3e2f-4a1b-8c9d-0e1f2a3b4c5d
                      resolved_match_ids:
                        - 665f0d4c2d2f7c2b2f2f2f31
                      skipped: []
                      warnings: []
        '400':
          description: >-
            Invalid request. JSON `CustomListError`; `error` is
            `validation_failed`, `resolve_requires_live_entry`,
            `allowlist_scope_not_allowed`, `allowlist_match_rules_not_allowed`,
            `allowlist_subject_is_listed_party`,
            `allowlist_expiry_out_of_range`, `allowlist_reserved_field`,
            `country_unresolved` (the screened subject has a country Minerva
            could not confirm; send `countries` explicitly, or `[]`;
            `data.field` is `countries` and nothing was written) or
            `not_an_allowlist` (the list is a screening list).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                resolve-requires-live-entry:
                  summary: >-
                    `resolve_match` without `publish` on an entry that is not
                    live. Nothing was written.
                  value:
                    error: resolve_requires_live_entry
                    message: >-
                      Publish the entry to mark this match. Send publish: true,
                      or publish the list first.
                allowlist-scope-not-allowed:
                  summary: A scope the workspace feed policy does not allow.
                  value:
                    error: allowlist_scope_not_allowed
                    message: This workspace allows only known records for PEP entries.
                allowlist-match-rules-not-allowed:
                  summary: A looser level than the workspace allows.
                  value:
                    error: allowlist_match_rules_not_allowed
                    message: This workspace allows Standard or tighter for these feeds.
                allowlist-subject-is-listed-party:
                  summary: >-
                    The customer's name equals the Sanctions record or one of
                    its aliases.
                  value:
                    error: allowlist_subject_is_listed_party
                    message: >-
                      The customer's name matches the sanctioned record it would
                      cover. Allowlist the customer, not the listed party.
                not-an-allowlist:
                  summary: The list is a screening list.
                  value:
                    error: not_an_allowlist
                    message: Customers can be added from a match only to an allowlist.
                country-unresolved:
                  summary: >-
                    `countries` omitted, and Minerva could not confirm the
                    screened subject's country. Nothing was written.
                  value:
                    error: country_unresolved
                    message: >-
                      We couldn't confirm this screen's country, so the entry
                      can't be limited to it. Send countries explicitly (ISO
                      3166-1 alpha-2), or [] to add it without a country.
                    data:
                      field: countries
        '403':
          description: >-
            No credentials were sent; the API key was revoked, has expired, or
            its application is deactivated (`API-key authentication was
            denied.`); the key is not an admin application key (**Workspace
            scoped** and **Tenant scoped** keys are refused); it belongs to
            another organization; or its creator is no longer an owner or admin.
            For a user token, the user is not a member, or is not an owner or
            admin on a write. If the tenant is not entitled to custom lists, the
            body is a JSON `CustomListError` with `error: not_enabled` (`Custom
            lists are not enabled for this tenant.`); every other 403 is plain
            text. Branch on `Content-Type`.
          content:
            text/plain:
              schema:
                type: string
                example: 'Missing Authorization: Api-Key or x-api-key header.'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                not-enabled:
                  summary: Tenant not entitled.
                  value:
                    error: not_enabled
                    message: Custom lists are not enabled for this tenant.
                allowlist-not-enabled:
                  summary: Allowlists are not enabled yet.
                  value:
                    error: allowlist_not_enabled
                    message: Allowlists are not enabled for this tenant.
        '404':
          description: >-
            The list, or the match in that workspace, is not visible to the
            caller. JSON `CustomListError` with `error: not_found`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                match-not-found:
                  summary: Unknown match, or a match in another workspace or tenant.
                  value:
                    error: not_found
                    message: Match not found.
        '409':
          description: >-
            `allowlist_entry_exists` (`data.status` is `archived`: restore it
            first), `allowlist_similar_entry_exists` (another entry has the same
            customer name; send its `record_uid`, or `create_separate: true`),
            or `conflict` (stale `expected_revision`; the entry write is kept).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                allowlist-similar-entry-exists:
                  summary: A similar entry exists.
                  value:
                    error: allowlist_similar_entry_exists
                    message: An entry with a similar name already exists on this list.
                    data:
                      record_uid: al_be8ed741b581485c4d5668ee
                      name: NatWest Bank
                allowlist-entry-exists-archived:
                  summary: The customer's entry is archived.
                  value:
                    error: allowlist_entry_exists
                    message: An entry for this customer already exists on this list.
                    data:
                      record_uid: al_be8ed741b581485c4d5668ee
                      status: archived
                stale-revision:
                  summary: '`expected_revision` is stale.'
                  value:
                    error: conflict
                    message: 'custom-list: conflict'
        '422':
          description: >-
            JSON `CustomListError`. `record_not_on_match`: `records[]` names a
            record that is not on the match. `no_uncovered_records`: `records`
            is `"all_uncovered"` (the default) and every record on the match is
            already covered by an allowlist entry.
            `allowlist_entry_cap_exceeded`: the list already holds the most
            entries an allowlist can hold; `data.max` is the cap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomListError'
              examples:
                record-not-on-match:
                  summary: A record that is not on the match.
                  value:
                    error: record_not_on_match
                    message: 'OFAC SDN: Natwest Holdings is not a record on this match.'
                no-uncovered-records:
                  summary: Every record on the match is already covered.
                  value:
                    error: no_uncovered_records
                    message: >-
                      Every record on this match is already covered by an
                      allowlist entry.
        '503':
          description: >-
            The authentication service is temporarily unavailable
            (`Authentication service is unavailable.`). Nothing was changed;
            retry with backoff.
          content:
            text/plain:
              schema:
                type: string
                example: Authentication service is unavailable.
      security:
        - AdminApiKeyAuth: []
        - UserTokenAuth: []
components:
  schemas:
    AllowlistFromMatchRequest:
      type: object
      description: >-
        Adds the screened customer of a potential match to an allowlist,
        covering the match's watchlist records exactly as Minerva captured them.
        This is the only way to pin a record's content (`record_ref`) from the
        API. Customer fields default to the screened subject when omitted.
      properties:
        match_id:
          type: string
          description: >-
            The potential match `id` from a search response or `GET
            /v2/search/matches`.
        workspace_id:
          type: string
          description: The workspace the match belongs to.
        record_uid:
          type: string
          nullable: true
          description: >-
            Add the covers to this existing entry instead of creating one.
            `null` creates or merges by the derived identity.
        records:
          description: >-
            Which of the match's records to cover: `"all_uncovered"` (the
            default), or a list of `{category, source, record_name}` taken from
            the match. A record that is not on the match returns `422` with
            `error: record_not_on_match`. With `"all_uncovered"`, a match whose
            records are all already covered returns `422` with `error:
            no_uncovered_records`.
          oneOf:
            - type: string
              enum:
                - all_uncovered
            - type: array
              items:
                $ref: '#/components/schemas/AllowlistCoverInput'
        name:
          type: string
        aliases:
          type: array
          items:
            type: string
        entity_type:
          type: string
          enum:
            - individual
            - organization
            - unknown
        date_of_birth:
          type: string
          nullable: true
        date_of_incorporation:
          type: string
          nullable: true
        countries:
          type: array
          items:
            type: string
          description: >-
            ISO 3166-1 alpha-2 codes the entry is limited to. Defaults to the
            screened country's code. If Minerva could not confirm the screened
            country, omitting this returns `400` `country_unresolved` and
            nothing is written; send the codes explicitly, or `[]` for no
            country.
        identifiers:
          $ref: '#/components/schemas/AllowlistIdentifiers'
        customer_ids:
          type: array
          items:
            type: string
        scope:
          description: >-
            `"known_records"` (default), `{"source": ["..."]}` or `{"category":
            "pep"}`. A scope the workspace's `allowlist.feedPolicy` does not
            allow for the match's feed returns `400` with `error:
            allowlist_scope_not_allowed`.
          oneOf:
            - type: string
              enum:
                - known_records
            - type: object
              properties:
                source:
                  type: array
                  items:
                    type: string
              required:
                - source
            - type: object
              properties:
                category:
                  type: string
              required:
                - category
        match_rules:
          allOf:
            - $ref: '#/components/schemas/AllowlistMatchRules'
          description: >-
            A level looser than the workspace's effective level for the match's
            feeds returns `400` with `error: allowlist_match_rules_not_allowed`.
        reason:
          type: string
        expires_at:
          type: string
        review_by:
          type: string
          nullable: true
        resolve_match:
          type: boolean
          default: true
          description: >-
            `true` (the default) also marks this match `suppressed` with
            `suppression_reason: allowlist`; send `false` to save the entry
            without resolving. The entry must be live: send `publish: true`, or
            the entry must already be in the live version, otherwise `400` with
            `error: resolve_requires_live_entry` and nothing is written.
        resolve_other_open_matches:
          type: boolean
          default: false
          description: >-
            With `resolve_match`, also mark the profile's other open matches the
            entry covers (up to 200). Direct API matches have no profile, so
            there are none.
        create_separate:
          type: boolean
          default: false
          description: >-
            `true` skips the similar-entry check
            (`allowlist_similar_entry_exists`) and creates a separate entry. It
            never skips the exact-identity check.
        publish:
          type: boolean
          default: false
        expected_revision:
          type: integer
          description: Required when `publish` is `true`.
      required:
        - match_id
        - workspace_id
        - reason
        - expires_at
    AllowlistFromMatchResponse:
      type: object
      properties:
        entry:
          $ref: '#/components/schemas/AllowlistEntry'
        working_set_revision:
          type: integer
        published_version_id:
          type: string
          description: Present only when `publish` was `true`.
        resolved_match_ids:
          type: array
          items:
            type: string
        skipped:
          type: array
          items:
            $ref: '#/components/schemas/AllowlistSkippedMatch'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/AllowlistWarning'
      required:
        - entry
        - working_set_revision
        - resolved_match_ids
        - skipped
        - warnings
    CustomListError:
      type: object
      properties:
        error:
          type: string
          description: >-
            Machine-readable code, e.g. `validation_failed`, `limit_exceeded`,
            `conflict`, `not_enabled`, `upload_capacity_exceeded`,
            `upload_request_timeout`. Allowlist codes:
            `allowlist_field_not_allowed`, `purpose_immutable`,
            `record_uid_not_allowed`, `allowlist_reserved_field`,
            `allowlist_identity_immutable`, `allowlist_scope_not_allowed`,
            `allowlist_match_rules_not_allowed`,
            `allowlist_expiry_out_of_range`,
            `allowlist_subject_is_listed_party`, `resolve_requires_live_entry`,
            `allowlist_not_enabled`, `not_found`, `allowlist_entry_exists`,
            `allowlist_similar_entry_exists`, `allowlist_entry_cap_exceeded`,
            `not_an_allowlist`, `record_not_on_match`, `no_uncovered_records`,
            `country_unresolved`. Branch on `error`; `message` is human-readable
            and may change.
        message:
          type: string
        limit:
          type: string
          description: >-
            For `limit_exceeded`: the entitlement limit, e.g.
            `maxRecordsPerList`.
        max:
          type: integer
          description: 'For `limit_exceeded`: the configured maximum.'
        retryable:
          type: boolean
        data:
          type: object
          additionalProperties: true
          description: >-
            Extra detail for some allowlist codes: `{record_uid, status}` for
            `allowlist_entry_exists`, `{record_uid, name}` for
            `allowlist_similar_entry_exists`, and `{max_expires_at}` for
            `allowlist_expiry_out_of_range`.
      additionalProperties: true
    AllowlistCoverInput:
      type: object
      description: >-
        One watchlist record the entry covers when `scope` is `known_records`.
        Copy `category`, `source` and `record_name` from the potential match.
      properties:
        category:
          type: string
          enum:
            - sanctions
            - pep
            - news
            - criminal
            - legal
          description: The feed of the record. `internal` is never allowed.
        source:
          type: string
          description: >-
            The source list, as it appears in `checklist.hits_info[].source`,
            e.g. `OFAC SDN`.
          example: OFAC SDN
        record_name:
          type: string
          description: The record's name on that source.
          example: Natwest Logistics LLC
      required:
        - category
        - source
        - record_name
    AllowlistIdentifiers:
      type: object
      description: >-
        Optional identifiers. When set, a screened subject that carries a
        different value is not accepted (`matched_on.comparison[].result:
        different`).
      properties:
        company_number:
          type: string
          nullable: true
        national_id:
          type: string
          nullable: true
    AllowlistMatchRules:
      type: object
      nullable: true
      description: >-
        An optional per-entry override of how closely a screened name must match
        the entry. `null` uses the workspace's `allowlist.matchRules.default`.
        Minerva never applies an override looser than the workspace allows: on
        Sanctions it is capped at the workspace level, and
        `matched_on.match_rules.source` on a match tells you which level
        applied.
      properties:
        level:
          type: string
          enum:
            - exact
            - standard
            - tolerant
      required:
        - level
      example:
        level: exact
    AllowlistEntry:
      type: object
      description: >-
        An allowlist entry. Returned in `data` by the record endpoints when the
        list's `purpose` is `allowlist`.
      properties:
        id:
          type: string
          description: Minerva's ID for the record.
        list_id:
          type: string
        record_uid:
          type: string
          description: >-
            Derived by Minerva from the customer's identity (name, entity type,
            dates, countries and identifiers). Keep it to address the entry
            later. Changing any of those fields on `PATCH` returns `400` with
            `error: allowlist_identity_immutable`: archive the entry and create
            a new one instead.
          example: al_be8ed741b581485c4d5668ee
        status:
          type: string
          enum:
            - active
            - archived
        name:
          type: string
          description: >-
            The customer's name: who you know them to be, not the watchlist
            record's name. Required.
          example: NatWest Bank
        aliases:
          type: array
          items:
            type: string
          description: >-
            Other spellings of the customer's name. A screened name is accepted
            when it matches `name` or any alias under the match rules.
          example:
            - NatWest
            - National Westminster Bank
        entity_type:
          type: string
          enum:
            - individual
            - organization
          nullable: true
          description: '`null` when the entry was saved without a type.'
        date_of_birth:
          type: string
          nullable: true
          description: >-
            `YYYY-MM-DD`. When set, a screened subject with a different date of
            birth is not accepted.
        date_of_incorporation:
          type: string
          nullable: true
          description: >-
            `YYYY-MM-DD`. When set, a screened subject with a different date is
            not accepted.
        countries:
          type: array
          items:
            type: string
          description: >-
            ISO 3166-1 alpha-2 codes. When set, a screened subject from another
            country is not accepted.
          example:
            - GB
        identifiers:
          $ref: '#/components/schemas/AllowlistIdentifiers'
        customer_ids:
          type: array
          items:
            type: string
          description: >-
            Your customer IDs for this entry. Returned here; never echoed in
            screening annotations.
        scope:
          type: string
          enum:
            - known_records
            - source
            - category
          description: >-
            Which matches the entry can mark. `known_records` (default): only
            the records in `covers`. `source`: any record from the sources in
            `sources`. `category`: any record in the feeds in `categories`. The
            workspace's `allowlist.feedPolicy` decides which scopes each feed
            allows; Sanctions always allows `known_records` only.
          example: known_records
        covers:
          type: array
          description: >-
            Required and non-empty when `scope` is `known_records`; rejected
            otherwise.
          items:
            $ref: '#/components/schemas/AllowlistCover'
        sources:
          type: array
          items:
            type: string
          description: >-
            Required when `scope` is `source`; rejected otherwise. Not allowed
            for Sanctions sources.
        categories:
          type: array
          items:
            type: string
            enum:
              - pep
              - news
              - criminal
              - legal
          description: >-
            Required when `scope` is `category`; rejected otherwise. `sanctions`
            and `internal` are never allowed.
        match_rules:
          $ref: '#/components/schemas/AllowlistMatchRules'
        reason:
          type: string
          description: >-
            Why this customer is not the listed party. Required; shown to
            analysts on every match the entry marks.
          example: Payee is NatWest Bank, the UK clearing bank
        expires_at:
          type: string
          format: date-time
          description: >-
            When the entry stops marking matches. A match screened at or after
            this time alerts with `allowlist.status: entry_expired`.
        review_by:
          type: string
          nullable: true
          description: Optional date to review the entry before it expires.
        custom_fields:
          type: object
          additionalProperties:
            type: string
          description: >-
            Your own string fields. The reserved names `record_ref`,
            `fingerprint`, `record_key` and any `_added_*` key return `400` with
            `error: allowlist_reserved_field`.
        added_by:
          $ref: '#/components/schemas/AllowlistActor'
        added_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        working_set_revision:
          type: integer
          description: 'Write responses only: the working-set revision after this write.'
        published_version_id:
          type: string
          description: >-
            Write responses only, and only when `publish` was `true`: the
            version the write was published in.
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/AllowlistWarning'
          description: Write responses only. Empty when there is nothing to warn about.
      required:
        - record_uid
        - status
        - name
        - scope
        - reason
        - expires_at
        - added_by
        - added_at
    AllowlistSkippedMatch:
      type: object
      properties:
        match_id:
          type: string
        reason:
          type: string
          enum:
            - subject_not_matched
            - details_not_matched
            - screened_name_is_record
            - record_not_covered
            - record_changed
            - not_open
            - not_live_yet
          description: >-
            Why the match was not marked. `not_open`: it is no longer open
            (already reviewed, suppressed, or reopened). `not_live_yet`: the
            version the entry is in is not yet readable by screening, or the
            list's live version changed while the request ran. The entry is
            saved; retry the resolve later or let the next screen apply it.
      required:
        - match_id
        - reason
    AllowlistWarning:
      type: object
      description: >-
        A non-blocking warning on a successful write.
        `allowlist_subject_is_listed_party`: the entry's name or an alias equals
        the name of a covered non-Sanctions record (on Sanctions this is a
        `400`). `allowlist_mode_off`: the workspace's allowlist mode is `off`,
        so the list has no effect yet.
      properties:
        code:
          type: string
          enum:
            - allowlist_subject_is_listed_party
            - allowlist_mode_off
        record_uid:
          type: string
        message:
          type: string
      required:
        - code
    AllowlistCover:
      allOf:
        - $ref: '#/components/schemas/AllowlistCoverInput'
        - type: object
          properties:
            record_ref:
              type: object
              readOnly: true
              description: >-
                Set by Minerva, never accepted on input. Present once the record
                has been captured, for example by adding the customer from a
                match. `fingerprint` identifies the record content the entry was
                approved against: if the record later changes, the match alerts
                again with `allowlist.status: record_changed`.
              properties:
                fingerprint:
                  type: string
                  example: >-
                    sha256:9341f26c078565780b5157f527395fb0bb82fc7f45e36a44aa871c579d5c97da
                record_aliases:
                  type: array
                  items:
                    type: string
                  example:
                    - NWL LLC
                    - Natwest Logistics
            added_by:
              $ref: '#/components/schemas/AllowlistActor'
            added_at:
              type: string
              format: date-time
    AllowlistActor:
      type: object
      description: >-
        Who added an entry or a cover. `type` is `application` for a change made
        with an admin application key, otherwise `user`.
      properties:
        type:
          type: string
          enum:
            - user
            - application
        id:
          type: string
        name:
          type: string
      required:
        - type
        - id
      example:
        type: user
        id: u_8d1e
        name: A. Analyst
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Admin API key for authentication. Manage API keys in the Minerva
        dashboard under Administration > Developers.
    AdminApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        An admin application key: `Authorization: Api-Key <token>` (or legacy
        `x-api-key`). Only tenant owners and admins can create one. Standard
        keys are refused with 403 on workspace management and tenant
        configuration routes.
    UserTokenAuth:
      type: apiKey
      in: header
      name: x-user-token
      description: Firebase user token for authentication

````

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