Create one or more entries in a matchlist
curl --request POST \
--url https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"entries": [
{
"attributes": [
{
"value": "<string>"
}
],
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "CERT-BAD-ACTOR-1234-5678",
"reasons": [
"<string>"
]
}
],
"batchName": "blocklist.csv",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
'import requests
url = "https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries"
payload = {
"entries": [
{
"attributes": [{ "value": "<string>" }],
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "CERT-BAD-ACTOR-1234-5678",
"reasons": ["<string>"]
}
],
"batchName": "blocklist.csv",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
api_key: '<api-key>',
'X-Frankie-CustomerID': '<x-frankie-customerid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entries: [
{
attributes: [{value: '<string>'}],
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
reference: 'CERT-BAD-ACTOR-1234-5678',
reasons: ['<string>']
}
],
batchName: 'blocklist.csv',
comment: {
text: 'Update after speaking to customer over the phone directly.',
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
}
})
};
fetch('https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries', 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/matchlists/{matchlistName}/entries",
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([
'entries' => [
[
'attributes' => [
[
'value' => '<string>'
]
],
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'reference' => 'CERT-BAD-ACTOR-1234-5678',
'reasons' => [
'<string>'
]
]
],
'batchName' => 'blocklist.csv',
'comment' => [
'text' => 'Update after speaking to customer over the phone directly.',
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Frankie-CustomerID: <x-frankie-customerid>",
"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/matchlists/{matchlistName}/entries"
payload := strings.NewReader("{\n \"entries\": [\n {\n \"attributes\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"CERT-BAD-ACTOR-1234-5678\",\n \"reasons\": [\n \"<string>\"\n ]\n }\n ],\n \"batchName\": \"blocklist.csv\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
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/matchlists/{matchlistName}/entries")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"entries\": [\n {\n \"attributes\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"CERT-BAD-ACTOR-1234-5678\",\n \"reasons\": [\n \"<string>\"\n ]\n }\n ],\n \"batchName\": \"blocklist.csv\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entries\": [\n {\n \"attributes\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"CERT-BAD-ACTOR-1234-5678\",\n \"reasons\": [\n \"<string>\"\n ]\n }\n ],\n \"batchName\": \"blocklist.csv\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}"
response = http.request(request)
puts response.read_body{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"matchlist": {
"matchlistId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"action": "BLOCK",
"state": "ACTIVE"
},
"entries": [
{
"attributes": [
{
"type": "ENTITY_TYPE",
"value": "<string>"
}
],
"entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"reference": "CERT-BAD-ACTOR-1234-5678",
"reasons": [
"<string>"
],
"state": "ACTIVE",
"batchName": "blocklist.csv",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Matchlists
Create one or more entries in a matchlist
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.
POST
/
v2
/
matchlists
/
{matchlistName}
/
entries
Create one or more entries in a matchlist
curl --request POST \
--url https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"entries": [
{
"attributes": [
{
"value": "<string>"
}
],
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "CERT-BAD-ACTOR-1234-5678",
"reasons": [
"<string>"
]
}
],
"batchName": "blocklist.csv",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
'import requests
url = "https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries"
payload = {
"entries": [
{
"attributes": [{ "value": "<string>" }],
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "CERT-BAD-ACTOR-1234-5678",
"reasons": ["<string>"]
}
],
"batchName": "blocklist.csv",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
api_key: '<api-key>',
'X-Frankie-CustomerID': '<x-frankie-customerid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entries: [
{
attributes: [{value: '<string>'}],
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
reference: 'CERT-BAD-ACTOR-1234-5678',
reasons: ['<string>']
}
],
batchName: 'blocklist.csv',
comment: {
text: 'Update after speaking to customer over the phone directly.',
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
}
})
};
fetch('https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries', 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/matchlists/{matchlistName}/entries",
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([
'entries' => [
[
'attributes' => [
[
'value' => '<string>'
]
],
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'reference' => 'CERT-BAD-ACTOR-1234-5678',
'reasons' => [
'<string>'
]
]
],
'batchName' => 'blocklist.csv',
'comment' => [
'text' => 'Update after speaking to customer over the phone directly.',
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Frankie-CustomerID: <x-frankie-customerid>",
"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/matchlists/{matchlistName}/entries"
payload := strings.NewReader("{\n \"entries\": [\n {\n \"attributes\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"CERT-BAD-ACTOR-1234-5678\",\n \"reasons\": [\n \"<string>\"\n ]\n }\n ],\n \"batchName\": \"blocklist.csv\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
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/matchlists/{matchlistName}/entries")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"entries\": [\n {\n \"attributes\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"CERT-BAD-ACTOR-1234-5678\",\n \"reasons\": [\n \"<string>\"\n ]\n }\n ],\n \"batchName\": \"blocklist.csv\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/matchlists/{matchlistName}/entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entries\": [\n {\n \"attributes\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"reference\": \"CERT-BAD-ACTOR-1234-5678\",\n \"reasons\": [\n \"<string>\"\n ]\n }\n ],\n \"batchName\": \"blocklist.csv\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}"
response = http.request(request)
puts response.read_body{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"matchlist": {
"matchlistId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"action": "BLOCK",
"state": "ACTIVE"
},
"entries": [
{
"attributes": [
{
"type": "ENTITY_TYPE",
"value": "<string>"
}
],
"entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"reference": "CERT-BAD-ACTOR-1234-5678",
"reasons": [
"<string>"
],
"state": "ACTIVE",
"batchName": "blocklist.csv",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Api-Keyjwt
Headers
Your API key provided by FrankieOne
Example:
"245c765b124a098d09ef8765...."
Your Customer ID provided by FrankieOne
Example:
"12345678-1234-1234-1234-123456789012"
Your Customer Child ID provided by FrankieOne
Example:
"87654321-4321-4321-4321-210987654321"
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.
Username provided by API caller
Example:
"fred.flintstone@frankieone.com"
Path Parameters
The name of the matchlist.
Body
application/json
Request to create one or more entries in a matchlist
Entries to create in the matchlist
Minimum array length:
1Show child attributes
Show child attributes
Optional name to identify a batch of matchlist entries. This name should reflect the source of the batch. When entries are later retrieved, they can be filtered by this batch name.
Example:
"blocklist.csv"
Show child attributes
Show child attributes
Response
OK
Response object for a list of matchlist entries.
The unique request identifier for the API call made.
Example:
"01HN9XHZN6MGXM9JXG50K59Q85"
The basic details for the matchlist to which the entry or entries belong.
Show child attributes
Show child attributes
Entries in the matchlist.
Show child attributes
Show child attributes
Was this page helpful?