FrankieOne

FrankieOne Matchlists API

The Matchlists API from FrankieOne — 6 operation(s) for matchlists.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.frankieone.com/v1.14.1/docs/welcome-to-frankie
📖
Documentation
https://docs.frankieone.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-matchlists-api-openapi.yml

Other Resources

🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/capabilities/frankieone-kyc-capabilities.yml
🔗
Rules
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/rules/frankieone-kyc-rules.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/capabilities/frankieone-core-capabilities.yml
🔗
Rules
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/rules/frankieone-core-rules.yml

OpenAPI Specification

frankieone-matchlists-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Core V2 Audit Matchlists API
  version: 2.0.0
  description: This is the APIs for V2 Core. It allows you to do common operations, such as read audit entries or get workflow lists.
  contact:
    name: FrankieOne
    url: https://www.frankieone.com/
    email: help@frankieone.com
servers:
- url: https://api.uat.frankie.one
security:
- Api-Key: []
tags:
- name: Matchlists
paths:
  /v2/search/matchlists:
    parameters:
    - $ref: '#/components/parameters/X-Frankie-CustomerID'
    - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
    - $ref: '#/components/parameters/X-Frankie-RequestID'
    - $ref: '#/components/parameters/X-Frankie-Channel'
    post:
      summary: Search for matchlist entries
      description: Retrieve all matching entries for the search criteria.
      operationId: searchMatchlists
      tags:
      - Matchlists
      parameters:
      - $ref: '#/components/parameters/limit'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Search-Matchlists-Request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Search-Matchlists-Matches-Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v2/matchlists:
    get:
      summary: Retrieve a list of matchlist details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  matchlists:
                    type: array
                    items:
                      $ref: '#/components/schemas/Matchlist'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getMatchlist
      description: Retrieve a list of matchlists that new entries can be added or removed.
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      - $ref: '#/components/parameters/query_matchlist_states'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/matchlists/{matchlistName}/entries:
    parameters:
    - $ref: '#/components/parameters/matchlistName'
    post:
      summary: Create one or more entries in a matchlist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Create-Matchlist-Entries-Request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Matchlist-Entries-Response'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: createMatchlistEntry
      description: 'Create a new entry in an existing matchlist.

        Entries must have at least one attribute and those attributes must be of valid types. Attribute values must have at least one non-whitespace character in their values.

        Optionally a batch name can be provided in the request, which will be applied to all given entries. The batch name should reflect the source of the entry list, for example blocklist.csv. The entries can later be retrieved by batch name.

        Optionally a reference can be provided for each entry in the request. The reference should be a unique name (but uniqueness is not required) from for example an externally sourced blocklist. The entries can later be retrieved by reference.

        Optionally each entry can refer to an entity ID and type (both ID and type, or neither), to indicate that the entry is based on en existing entity.'
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    get:
      summary: Get a list of matchlist entries
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entries:
                    type: array
                    items:
                      $ref: '#/components/schemas/Matchlist-Entry'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getMatchlistEntries
      description: 'The query parameter `entityId` can be used to filter the entries by entity ID. The entity UUID must be in lower case.

        The query parameter `reference` can be used to filter the entries by reference.

        The query parameter `batchName` can be used to filter the entries by batch name.

        The query parameter `states` can be used to filter the entries by state. If set, the response will include only entries with the specified states. By default only `ACTIVE` entries are returned if the matchlist is `ACTIVE`. If the matchlist is `ARCHIVED` only `EXPIRED` entries will be returned. Possible values are: `ACTIVE`, `EXPIRED`, and `DELETED`. Multiple values can be provided as a comma-separated list. For example, `DELETED,EXPIRED`.

        The query parameter `sortFields` (`createdAt`, `updatedAt` or `state`) can be set to one or more fields for sorting. The default is to use just `createdAt`.

        The query parameter `sort` can set the sort order to ascending (`asc`) or descending (`desc`). The default is ascending.

        The query parameters `limit` (default 10) and `page` (default 1) can be used to control paging of the returned entries. The values given must be positive.

        If no matching entries are found, or the page is too large, then the entries array will be empty, but the result code is still 200.

        In addition to the entries, the response will also include the basic details of the matchlist, including its state. This is important, since if a matchlist is `ARCHIVED`, all previously `ACTIVE` entries will be `EXPIRED`, and will only be seen in the response if the `states` includes `EXPIRED`. So the entries array will be blank for `ARCHIVED` matchlists if `states` is not given.'
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      - $ref: '#/components/parameters/query_entry_states'
      - $ref: '#/components/parameters/query_batch_name'
      - $ref: '#/components/parameters/query_reference'
      - $ref: '#/components/parameters/query_entity_id'
      - $ref: '#/components/parameters/query_entry_id'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/matchlist_sort_fields'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/matchlists/{matchlistName}/entries/{entryId}:
    parameters:
    - $ref: '#/components/parameters/matchlistName'
    - $ref: '#/components/parameters/entryId'
    patch:
      operationId: updateMatchlistEntry
      summary: Modify a matchlist entry
      description: "This can be used in updating a matchlist entry's non-attribute fields such as `reference`, `state`, `reason`.\n\nThis endpoint can also be used to \"delete\" an entry by changing its state to `DELETED` and capturing comments.\n\nNOTE: Updating `attributes` field of a matchlist entry is not allowed. An entry could be used in existing matches, and modifying attributes directly could lead to inconsistencies. \nAs a workaround, retrieve the entry details, then create a new entry with the original and updated values. The old entry should have its state changed to `DELETED`."
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entry:
                  $ref: '#/components/schemas/Update-Matchlist-Entry-Request'
                comment:
                  $ref: '#/components/schemas/Comment'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entry:
                    $ref: '#/components/schemas/Matchlist-Entry'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    get:
      operationId: getMatchlistEntry
      summary: Retrieve a matchlist entry
      description: Retrieve a single matchlist entry using an entryId.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entry:
                    $ref: '#/components/schemas/Matchlist-Entry'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/matchlists/{matchlistName}/entries/addEntity:
    parameters:
    - $ref: '#/components/parameters/matchlistName'
    post:
      summary: Add an individual entity to a matchlist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Add-Matchlist-Entity-Request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entry:
                    $ref: '#/components/schemas/Matchlist-Entry'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: addMatchlistEntity
      description: Creates an individual entity and its attributes as a new entry in an existing matchlist.
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/matchlists/{matchlistName}/entries/removeEntity:
    parameters:
    - $ref: '#/components/parameters/matchlistName'
    patch:
      summary: Remove an individual entity matchlist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Remove-Matchlist-Entity-Request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  entityId:
                    $ref: '#/components/schemas/Entity-ID'
                  matchlistId:
                    $ref: '#/components/schemas/Matchlist-ID'
                  state:
                    $ref: '#/components/schemas/Matchlist-Entry-State'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: removeMatchlistEntity
      description: "Remove a matchlist entry's state using an entity ID. This automatically sets the state of the entry to `DELETED` .\n- **Important**: Deletion cannot be undone.\n- Delete a matchlist entry using the `entityId` associated with the entry.\n- Deleted entries will not be used for screening.\n- However, deleted entries can still be retrieved:\n  - By `entityId`, using the multi-entry `GET` (list) API, by specifying an `includeStates` filter that includes `DELETED`."
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Matchlists
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
components:
  schemas:
    Matchlist-State:
      type: string
      description: "The state of the matchlist. Possible values:\n  - \"ACTIVE\": The matchlist is active and can be used for matching. Note: the default matchlist is always active.\n  - \"ARCHIVED\": The matchlist is archived and cannot be used for matching."
      default: ACTIVE
      enum:
      - ACTIVE
      - ARCHIVED
    Error-Base:
      type: object
      properties:
        errorCode:
          type: string
        errorMsg:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
    Search-Matchlists-Matches-Response:
      type: object
      description: 'All matches for a matchlist search. The entries contain the matchlist ID reference for looking up the matchlist details in matchlists.

        If there are no matches, empty lists are returned.

        Results will be ordered by descending entry match confidence for fuzzy searches, and otehrwise by matchlist and entry ID.'
      required:
      - requestId
      - matchlists
      - entries
      - meta
      properties:
        requestId:
          $ref: '#/components/schemas/Request-ID'
        matchlists:
          type: object
          description: 'List of matchlists with at least one matches entry in the entries list. Keyed on the matchlist ID which is also present in

            entries.

            '
          additionalProperties:
            $ref: '#/components/schemas/Matchlist-Base'
        entries:
          type: array
          description: 'The list of matches that match the search criteria. Includes associated match strengths if the search was fuzzy.

            If no matches were found, the list will be empty.'
          items:
            $ref: '#/components/schemas/Matchlists-Search-Matched-Entry'
        meta:
          type: object
          description: Meta information about the request and response that will be returned during a search operation
          required:
          - total
          - limit
          - count
          properties:
            total:
              type: integer
              description: The Total number of items that have been found for the search criteria
            limit:
              type: integer
              description: The current limit applied for this response
            count:
              type: integer
              description: The number of items that were returned in this response
    Matchlists-Search-Matched-Attribute:
      type: object
      description: An entry attribute th

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-matchlists-api-openapi.yml