Fetch the details for a specific alert
curl --request GET \
--url https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId} \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'apiKey: <api-key>'import requests
url = "https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}"
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"apiKey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Frankie-CustomerID': '<x-frankie-customerid>', apiKey: '<api-key>'}
};
fetch('https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}', 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.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Frankie-CustomerID: <x-frankie-customerid>",
"apiKey: <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"
"net/http"
"io"
)
func main() {
url := "https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("apiKey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("apiKey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["apiKey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"checkId": "7eb4432d-398b-40f7-b24b-7d1208b83e2a",
"alertId": "db30f17e-5e79-4185-b7d5-6dfc06478055",
"resultId": "89022126-ae30-4d06-b73d-95cf16230d3c",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"transactionTimestamp": "<string>",
"createdDate": "<string>",
"lastUpdated": "<string>",
"status": "PENDING",
"riskLevel": "MEDIUM",
"activityType": "REGISTRATION",
"source": "<string>",
"issueType": "DEVICE",
"riskToken": {
"sessionKey": "<string>",
"userId": "<string>"
},
"paymentId": "<string>",
"paymentType": "CARD",
"sourceLink": "<string>",
"deviceId": "<string>",
"assignedTo": "<string>",
"amount": {
"value": "<string>",
"currCode": "<string>"
},
"subtype": "<string>",
"originatingCheck": {
"riskToken": {
"sessionKey": "<string>",
"userId": "<string>"
},
"transactionId": "<string>",
"customer": {
"customerId": "<string>",
"customerType": "<string>",
"dataSource": "<string>",
"productType": "<string>",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"frankieId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"createdDatetime": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"dob": "1983-04-22",
"address": {
"country": "Testalia",
"addressId": "<string>",
"addressType": "RESIDENTIAL",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"careOf": "<string>",
"unitNumber": "Suite 1006",
"streetNumber": "42a",
"streetName": "Test Eagle",
"streetType": "Road",
"buildingName": "Tower of Power",
"suburb": "Testbeds",
"town": "Testville",
"region": "Test County",
"state": "TST",
"postalCode": "123-TST"
},
"email": "<string>",
"phone": "<string>",
"consent": "UNKNOWN",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"activity": {
"activityType": "REGISTRATION",
"timestamp": "2023-11-07T05:31:56Z",
"customerTransaction": {
"paymentRole": "TXN_ROLE_ORIGINATOR",
"paymentType": "CARD",
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"transactionType": "BUY",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"disbursementType": "BILLPAY",
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"transferType": "ACH",
"accountType": "CHECKING",
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountClass": "PERSONAL",
"accountExtId": "<string>",
"accountExtType": "EXTERNAL_IDNO",
"extraData": {}
},
"counterParty": {
"partyDetails": {
"customerId": "<string>",
"customerType": "<string>",
"dataSource": "<string>",
"productType": "<string>",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"frankieId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"createdDatetime": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"dob": "1983-04-22",
"address": {
"country": "Testalia",
"addressId": "<string>",
"addressType": "RESIDENTIAL",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"careOf": "<string>",
"unitNumber": "Suite 1006",
"streetNumber": "42a",
"streetName": "Test Eagle",
"streetType": "Road",
"buildingName": "Tower of Power",
"suburb": "Testbeds",
"town": "Testville",
"region": "Test County",
"state": "TST",
"postalCode": "123-TST"
},
"email": "<string>",
"phone": "<string>",
"consent": "UNKNOWN",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"transactionDetails": {
"paymentRole": "TXN_ROLE_ORIGINATOR",
"paymentType": "CARD",
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"transactionType": "BUY",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"disbursementType": "BILLPAY",
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"transferType": "ACH",
"accountType": "CHECKING",
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountClass": "PERSONAL",
"accountExtId": "<string>",
"accountExtType": "EXTERNAL_IDNO",
"extraData": {}
}
}
},
"checkId": "<string>",
"device": {
"id": "<string>",
"origin": "<string>",
"os": "<string>",
"browser": "<string>",
"platform": "<string>",
"riskScore": 123,
"ip": "127.0.0.1",
"ipGeoAsn": "<string>",
"ipGeoCity": "<string>",
"ipGeoCountry": "<string>",
"ipGeoLat": "<string>",
"ipGeoLong": "<string>",
"isBot": true,
"isRat": true,
"isMobileBot": true,
"isRecentRat": true,
"isSupported": true,
"isEmulated": true,
"session": "<string>",
"activity": "<string>",
"extraData": {}
},
"extraData": {}
}
}{
"commit": "<string>",
"requestId": "<string>",
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"issues": [
{
"issueLocation": "date_of_birth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"commit": "<string>",
"requestId": "<string>",
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"issues": [
{
"issueLocation": "date_of_birth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"commit": "<string>",
"requestId": "<string>",
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"issues": [
{
"issueLocation": "date_of_birth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}Alerts
Fetch the details for a specific alert
GET
/
alerts
/
{alertId}
Fetch the details for a specific alert
curl --request GET \
--url https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId} \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'apiKey: <api-key>'import requests
url = "https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}"
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"apiKey": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Frankie-CustomerID': '<x-frankie-customerid>', apiKey: '<api-key>'}
};
fetch('https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}', 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.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Frankie-CustomerID: <x-frankie-customerid>",
"apiKey: <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"
"net/http"
"io"
)
func main() {
url := "https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("apiKey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("apiKey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/transaction/v2/alerts/{alertId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["apiKey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"checkId": "7eb4432d-398b-40f7-b24b-7d1208b83e2a",
"alertId": "db30f17e-5e79-4185-b7d5-6dfc06478055",
"resultId": "89022126-ae30-4d06-b73d-95cf16230d3c",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"transactionTimestamp": "<string>",
"createdDate": "<string>",
"lastUpdated": "<string>",
"status": "PENDING",
"riskLevel": "MEDIUM",
"activityType": "REGISTRATION",
"source": "<string>",
"issueType": "DEVICE",
"riskToken": {
"sessionKey": "<string>",
"userId": "<string>"
},
"paymentId": "<string>",
"paymentType": "CARD",
"sourceLink": "<string>",
"deviceId": "<string>",
"assignedTo": "<string>",
"amount": {
"value": "<string>",
"currCode": "<string>"
},
"subtype": "<string>",
"originatingCheck": {
"riskToken": {
"sessionKey": "<string>",
"userId": "<string>"
},
"transactionId": "<string>",
"customer": {
"customerId": "<string>",
"customerType": "<string>",
"dataSource": "<string>",
"productType": "<string>",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"frankieId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"createdDatetime": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"dob": "1983-04-22",
"address": {
"country": "Testalia",
"addressId": "<string>",
"addressType": "RESIDENTIAL",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"careOf": "<string>",
"unitNumber": "Suite 1006",
"streetNumber": "42a",
"streetName": "Test Eagle",
"streetType": "Road",
"buildingName": "Tower of Power",
"suburb": "Testbeds",
"town": "Testville",
"region": "Test County",
"state": "TST",
"postalCode": "123-TST"
},
"email": "<string>",
"phone": "<string>",
"consent": "UNKNOWN",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"activity": {
"activityType": "REGISTRATION",
"timestamp": "2023-11-07T05:31:56Z",
"customerTransaction": {
"paymentRole": "TXN_ROLE_ORIGINATOR",
"paymentType": "CARD",
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"transactionType": "BUY",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"disbursementType": "BILLPAY",
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"transferType": "ACH",
"accountType": "CHECKING",
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountClass": "PERSONAL",
"accountExtId": "<string>",
"accountExtType": "EXTERNAL_IDNO",
"extraData": {}
},
"counterParty": {
"partyDetails": {
"customerId": "<string>",
"customerType": "<string>",
"dataSource": "<string>",
"productType": "<string>",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"frankieId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"createdDatetime": "2023-11-07T05:31:56Z",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"dob": "1983-04-22",
"address": {
"country": "Testalia",
"addressId": "<string>",
"addressType": "RESIDENTIAL",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"careOf": "<string>",
"unitNumber": "Suite 1006",
"streetNumber": "42a",
"streetName": "Test Eagle",
"streetType": "Road",
"buildingName": "Tower of Power",
"suburb": "Testbeds",
"town": "Testville",
"region": "Test County",
"state": "TST",
"postalCode": "123-TST"
},
"email": "<string>",
"phone": "<string>",
"consent": "UNKNOWN",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"transactionDetails": {
"paymentRole": "TXN_ROLE_ORIGINATOR",
"paymentType": "CARD",
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"transactionType": "BUY",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"disbursementType": "BILLPAY",
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"transferType": "ACH",
"accountType": "CHECKING",
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountClass": "PERSONAL",
"accountExtId": "<string>",
"accountExtType": "EXTERNAL_IDNO",
"extraData": {}
}
}
},
"checkId": "<string>",
"device": {
"id": "<string>",
"origin": "<string>",
"os": "<string>",
"browser": "<string>",
"platform": "<string>",
"riskScore": 123,
"ip": "127.0.0.1",
"ipGeoAsn": "<string>",
"ipGeoCity": "<string>",
"ipGeoCountry": "<string>",
"ipGeoLat": "<string>",
"ipGeoLong": "<string>",
"isBot": true,
"isRat": true,
"isMobileBot": true,
"isRecentRat": true,
"isSupported": true,
"isEmulated": true,
"session": "<string>",
"activity": "<string>",
"extraData": {}
},
"extraData": {}
}
}{
"commit": "<string>",
"requestId": "<string>",
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"issues": [
{
"issueLocation": "date_of_birth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"commit": "<string>",
"requestId": "<string>",
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"issues": [
{
"issueLocation": "date_of_birth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"commit": "<string>",
"requestId": "<string>",
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"issues": [
{
"issueLocation": "date_of_birth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}Authorizations
API key issued by FrankieOne. This will rotate regularly.
Headers
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"
Path Parameters
Unique identifier of a Transaction Check Alert The unique identifier for an alert that has been created when customer configuration thresholds are breached.
Example:
"db30f17e-5e79-4185-b7d5-6dfc06478055"
Response
Alert information
The unique identifier for a transaction monitoring check that was execute for a transaction
Example:
"7eb4432d-398b-40f7-b24b-7d1208b83e2a"
The unique identifier for an alert that has been created when customer configuration thresholds are breached.
Example:
"db30f17e-5e79-4185-b7d5-6dfc06478055"
The unique identifier for a result that was returned from a transaction check
Example:
"89022126-ae30-4d06-b73d-95cf16230d3c"
The unique identifier for a FrankieOne entity construct
Example:
"98ded7ac-2457-4bde-b27c-fcee05301262"
ISO-8601 format date-time that the transaction occurred
ISO-8601 format date-time that the alert was created
ISO-8601 format date-time of the time that alert was last updated
Current status of an alert
Available options:
PENDING, APPROVED, MANUALLY_APPROVED, MANUALLY_DECLINED Level of risk as determined by the service.
Available options:
NONE, LOW, MEDIUM, HIGH, VERY_HIGH Example:
"MEDIUM"
Type of the activity that was used for the check
Available options:
REGISTRATION, LOGIN, FIAT_WITHDRAWAL, FIAT_DEPOSIT, CRYPTO_WITHDRAWAL, CRYPTO_DEPOSIT Name of the upstream vendor of where the alert came from
Enum of risk assessment groupings, such as customer, device, transaction, AML, PEP as determined by the risk checking service
Available options:
DEVICE, TRANSACTION, AML, FRAUD Includes any data required for authorizations by upstream services. To confirm if this is required, please reach out to the FrankieOne Support team.
Show child attributes
Show child attributes
Identifier for the customer transaction, only populated for financial transaction checks
The type of payment that the transaction used.
Available options:
CARD, BANK, WIRE, CRYPTO, OTHER URL to the upstream vendor to provide more information about the transaction
Identifier of the device that was used for this check, this would be provided from the initial request data
Current FrankieOne Portal user that is assigned to this user
The amount described in the transaction risk check
Show child attributes
Show child attributes
The subtype of the risk check
A recorded activity that is/has been assessed by the Transaction Monitoring Service
Show child attributes
Show child attributes
Was this page helpful?