How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
FrankieOne

FrankieOne Matchlists API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

FrankieOne Matchlists API is one of 13 APIs that FrankieOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Matchlists. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 6 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.uat.frankie.one.

8 operations 6 paths 38 schemas 3 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.frankie.one
Authentication
API Key, HTTP Bearer
Contact
FrankieOne
Resource Areas
1

Authentication & Security 2

FrankieOne Matchlists API declares 2 security schemes for authenticating requests. An API key is passed in the header as api_key (Api-Key). It accepts HTTP bearer tokens (JWT) (jwt). By default, every request must be authenticated.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 3 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Matchlists 8
POST
/v2/search/matchlists
Search for matchlist entries
searchMatchlists 5 params body → 200400401403422500503
GET
/v2/matchlists
Retrieve a list of matchlist details
getMatchlist 7 params → 200400401404500502503
POST
/v2/matchlists/{matchlistName}/entries
Create one or more entries in a matchlist
createMatchlistEntry 6 params body → 200400401404500502503
GET
/v2/matchlists/{matchlistName}/entries
Get a list of matchlist entries
getMatchlistEntries 15 params → 200400401404500502503
PATCH
/v2/matchlists/{matchlistName}/entries/{entryId}
Modify a matchlist entry
updateMatchlistEntry 8 params body → 200400401404500502503
GET
/v2/matchlists/{matchlistName}/entries/{entryId}
Retrieve a matchlist entry
getMatchlistEntry 8 params → 200400401404500502503
POST
/v2/matchlists/{matchlistName}/entries/addEntity
Add an individual entity to a matchlist
addMatchlistEntity 7 params body → 200400401404409500502503
PATCH
/v2/matchlists/{matchlistName}/entries/removeEntity
Remove an individual entity matchlist
removeMatchlistEntity 7 params body → 200400401404500502503

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Matchlist-Base (6 properties), Create-Matchlist-Entry-Request (5 properties), Matchlist-Entry-Base (5 properties), Matchlist-Entry-Matchlist (4 properties). Each schema is shown below with its type and property counts.

Matchlists-Search-Filter
object
Specification of the matchlists to be searched. By default, only the default matchlist is searched.
2 properties
Entity-Type-Writeable
string
The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN".
Search-Confidence
number
Confidence level of the search result, represented as a number between 0 and 1. A higher value indicates greater confidence in the accuracy of the search resul…
Comment
object
2 properties
Matchlist-Action
string
Default action recommended for a match. The action can be one of the following: - BLOCK: Recommended action is to block the entity. - ALERT: Recommended action…
Entity-Type
string
The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN".
Matchlist-Base
object
Basic details about a matchlist, excluding metadata.
6 properties
Matchlist-Entry
object
Represents a single entry in a matchlist.
Search-Type
string
Specifies the type of search to perform. - "EXACT": Returns only results that exactly match the search term. - "FUZZY": Returns results that are similar to the…
Matchlist
object
A matchlist is a collection of entries used to match against incoming data.
Create-Matchlist-Entry-Request
object
Request to create an entry in a matchlist. The entity ID and type must either both be omitted, or both be provided. Note that the entity type is separate from…
5 properties 1 required
Matchlist-Entry-State
string
The state of the matchlist entry. - ACTIVE: The matchlist entry is active and can be used for matching. - EXPIRED: The matchlist entry has expired. It is visib…
Error-Base
object
3 properties
Entity-ID-Writeable
string
Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.…
Search-Matchlists-Matches-Response
object
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,…
4 properties 4 required
Remove-Matchlist-Entity-Request
object
Used for removing an entity from a matchlist.
3 properties 1 required
Issue
object
3 properties
Matchlist-Entry-Reason-Code
string
The reason code for the matchlist entry. This code will be translated to a configured description string. Supported codes are 1 to 24 characters long, consisti…
Matchlist-Entry-Matchlist
object
The basic details for the matchlist to which the entry or entries belong.
4 properties 4 required
Search-Matchlists-Request
object
Request to search for entries one or more matchlists
2 properties 1 required
Update-Matchlist-Entry-Request
object
Request to change the state and the optional parts of an entry in a matchlist.
3 properties
Matchlist-Entry-Base-With-Audit
object
Basic details about a matchlist entry, including audit metadata.
Error
object
Request-ID
string
The unique request identifier for the API call made.
Matchlists-Search-Matched-Attribute
object
An entry attribute that matched the matchlist search criteria.
2 properties 1 required
Matchlists-Search-Matched-Entry
object
An entry that matched the matchlist search criteria.
4 properties 3 required
Create-Matchlist-Entries-Request
object
Request to create one or more entries in a matchlist
3 properties 1 required
Matchlists-Search-Criteria
object
Specification of the matchlist entry attributes to search for.
2 properties 1 required
Matchlist-State
string
The state of the matchlist. Possible values: - "ACTIVE": The matchlist is active and can be used for matching. Note: the default matchlist is always active. -…
Matchlist-ID
string
Matchlists are assigned an auto-generated UUID to ensure global uniqueness, represented as matchlistId. The matchlistId allows for precise modification when re…
Matchlist-Entry-Base
object
Basic details about a matchlist entry, excluding metadata.
5 properties
Add-Matchlist-Entity-Request
object
Used for adding an entity to a matchlist
4 properties 1 required
Matchlist-Entry-Attribute
object
Represents a single attribute of a matchlist entry.
2 properties 2 required
Matchlist-Entries-Response
object
Response object for a list of matchlist entries.
3 properties 3 required
Matchlist-Entry-Attributes
array
All attributes associated with a matchlist entry.
Matchlist-Entry-State-Writeable
string
The state of the matchlist entry. - ACTIVE: The matchlist entry is active and can be used for matching. - EXPIRED: The matchlist entry has expired. It is visib…
Entity-ID
string
Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.…
Matchlist-Entry-Attribute-Type
string
Entity attributes eligible for screening. A matchlist entry may not contain both ORG and IND attributes, and they must match the ENTITYTYPE if it is provided.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

frankieone-matchlists-api-openapi.yml Raw ↑

Other APIs FrankieOne publishes across the network.

FrankieOne Audit API
AE Profile APIs.io
FrankieOne HostedURL API
AE Profile APIs.io
FrankieOne IDV API
AE Profile APIs.io
FrankieOne Individual Documents API
AE Profile APIs.io
FrankieOne Individual Entities API
AE Profile APIs.io
FrankieOne Individual Entity Elements API
AE Profile APIs.io
FrankieOne Individual Profiles API
AE Profile APIs.io
FrankieOne Individual Results API
AE Profile APIs.io
FrankieOne Individual Risks API
AE Profile APIs.io
FrankieOne Individual Workflows API
AE Profile APIs.io
FrankieOne Monitoring API
AE Profile APIs.io
FrankieOne Search API
AE Profile APIs.io
#Matchlists
← Back to F APIs
API Details
ID
frankieone:frankieone-matchlists-api
Base URL
https://api.frankie.one
Docs
https://docs.frankieone.com/v1.14.1/docs/welcome-to-frankie
Provider
FrankieOne
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=frankieone-matchlists-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/frankieone-matchlists-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of FrankieOne Matchlists API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.