Skip to main content
POST
/
v2
/
search
/
matchlists
Search for matchlist entries
curl --request POST \
  --url https://api.uat.frankie.one/v2/search/matchlists \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'X-Frankie-RequestID: <x-frankie-requestid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "search": {
    "attributes": [
      {
        "value": "<string>"
      }
    ]
  },
  "filter": {
    "listScope": "DEFAULT",
    "searchLists": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}
'
import requests

url = "https://api.uat.frankie.one/v2/search/matchlists"

payload = {
    "search": { "attributes": [{ "value": "<string>" }] },
    "filter": {
        "listScope": "DEFAULT",
        "searchLists": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
    }
}
headers = {
    "X-Frankie-CustomerID": "<x-frankie-customerid>",
    "X-Frankie-RequestID": "<x-frankie-requestid>",
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'X-Frankie-CustomerID': '<x-frankie-customerid>',
    'X-Frankie-RequestID': '<x-frankie-requestid>',
    api_key: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    search: {attributes: [{value: '<string>'}]},
    filter: {listScope: 'DEFAULT', searchLists: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']}
  })
};

fetch('https://api.uat.frankie.one/v2/search/matchlists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.uat.frankie.one/v2/search/matchlists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'search' => [
        'attributes' => [
                [
                                'value' => '<string>'
                ]
        ]
    ],
    'filter' => [
        'listScope' => 'DEFAULT',
        'searchLists' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Frankie-CustomerID: <x-frankie-customerid>",
    "X-Frankie-RequestID: <x-frankie-requestid>",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uat.frankie.one/v2/search/matchlists"

	payload := strings.NewReader("{\n  \"search\": {\n    \"attributes\": [\n      {\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"filter\": {\n    \"listScope\": \"DEFAULT\",\n    \"searchLists\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
	req.Header.Add("X-Frankie-RequestID", "<x-frankie-requestid>")
	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.uat.frankie.one/v2/search/matchlists")
  .header("X-Frankie-CustomerID", "<x-frankie-customerid>")
  .header("X-Frankie-RequestID", "<x-frankie-requestid>")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search\": {\n    \"attributes\": [\n      {\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"filter\": {\n    \"listScope\": \"DEFAULT\",\n    \"searchLists\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.uat.frankie.one/v2/search/matchlists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["X-Frankie-RequestID"] = '<x-frankie-requestid>'
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"search\": {\n    \"attributes\": [\n      {\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"filter\": {\n    \"listScope\": \"DEFAULT\",\n    \"searchLists\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "matchlists": {},
  "entries": [
    {
      "matchlistId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entry": {
        "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "reference": "CERT-BAD-ACTOR-1234-5678",
        "reasons": [
          "<string>"
        ],
        "createdBy": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedBy": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "attributes": [
        {
          "attribute": {
            "value": "<string>"
          },
          "confidence": 0.5
        }
      ],
      "confidence": 0.5
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "count": 123
  }
}
{
  "errorCode": "<string>",
  "errorMsg": "<string>",
  "details": [
    {
      "issue": "<string>",
      "issueLocation": "<string>",
      "issueType": "<string>"
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
  "errorCode": "<string>",
  "errorMsg": "<string>",
  "details": [
    {
      "issue": "<string>",
      "issueLocation": "<string>",
      "issueType": "<string>"
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
  "errorCode": "<string>",
  "errorMsg": "<string>",
  "details": [
    {
      "issue": "<string>",
      "issueLocation": "<string>",
      "issueType": "<string>"
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
  "errorCode": "<string>",
  "errorMsg": "<string>",
  "details": [
    {
      "issue": "<string>",
      "issueLocation": "<string>",
      "issueType": "<string>"
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
  "errorCode": "<string>",
  "errorMsg": "<string>",
  "details": [
    {
      "issue": "<string>",
      "issueLocation": "<string>",
      "issueType": "<string>"
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
  "errorCode": "<string>",
  "errorMsg": "<string>",
  "details": [
    {
      "issue": "<string>",
      "issueLocation": "<string>",
      "issueType": "<string>"
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

Authorizations

​
api_key
string
header
required

Headers

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-RequestID
string
required

GUID identifier for request

Example:

"82988375-1F9C-40C7-8543-ECCA0D94CC7C"

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Query Parameters

​
limit
integer
default:20

Limit the number of items that will be returned as part of the request

Required range: x >= 1

Body

application/json

Request to search for entries one or more matchlists

​
search
object
required

Specification of the matchlist entry attributes to search for.

​
filter
object

Specification of the matchlists to be searched. By default, only the default matchlist is searched.

Response

OK

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.

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
matchlists
object
required

List of matchlists with at least one matches entry in the entries list. Keyed on the matchlist ID which is also present in entries.

​
entries
object[]
required

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.

​
meta
object
required

Meta information about the request and response that will be returned during a search operation