Check a transaction's risk
curl --request POST \
--url https://api.kycaml.frankiefinancial.io/transaction/v2/transactions \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'apiKey: <api-key>' \
--data '
{
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"activity": {
"timestamp": "2023-11-07T05:31:56Z",
"customerTransaction": {
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountExtId": "<string>",
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"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": {}
}
'import requests
url = "https://api.kycaml.frankiefinancial.io/transaction/v2/transactions"
payload = {
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"activity": {
"timestamp": "2023-11-07T05:31:56Z",
"customerTransaction": {
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountExtId": "<string>",
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"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": {}
}
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"apiKey": "<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>',
apiKey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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',
email: '<string>',
phone: '<string>',
nationalId: '<string>',
companyName: '<string>',
extraData: {}
},
activity: {
timestamp: '2023-11-07T05:31:56Z',
customerTransaction: {
paymentId: '<string>',
paymentAmount: 123,
currencyCode: '<string>',
accountPan: '<string>',
paymentDesc: '<string>',
paymentStatus: '<string>',
order: {
prevOrderCount: 123,
lastOrderDate: '1983-04-22',
orderChannel: '<string>',
prevUnpaidOrderCount: 123
},
merchant: {id: '<string>', mcc: '<string>', category: '<string>'},
hashedPan: '<string>',
maskedPan: '<string>',
accountRoute: '<string>',
accountIban: '<string>',
accountSwift: '<string>',
accountName: '<string>',
accountExtId: '<string>',
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',
email: '<string>',
phone: '<string>',
nationalId: '<string>',
companyName: '<string>',
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: {}
})
};
fetch('https://api.kycaml.frankiefinancial.io/transaction/v2/transactions', 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/transactions",
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([
'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',
'email' => '<string>',
'phone' => '<string>',
'nationalId' => '<string>',
'companyName' => '<string>',
'extraData' => [
]
],
'activity' => [
'timestamp' => '2023-11-07T05:31:56Z',
'customerTransaction' => [
'paymentId' => '<string>',
'paymentAmount' => 123,
'currencyCode' => '<string>',
'accountPan' => '<string>',
'paymentDesc' => '<string>',
'paymentStatus' => '<string>',
'order' => [
'prevOrderCount' => 123,
'lastOrderDate' => '1983-04-22',
'orderChannel' => '<string>',
'prevUnpaidOrderCount' => 123
],
'merchant' => [
'id' => '<string>',
'mcc' => '<string>',
'category' => '<string>'
],
'hashedPan' => '<string>',
'maskedPan' => '<string>',
'accountRoute' => '<string>',
'accountIban' => '<string>',
'accountSwift' => '<string>',
'accountName' => '<string>',
'accountExtId' => '<string>',
'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',
'email' => '<string>',
'phone' => '<string>',
'nationalId' => '<string>',
'companyName' => '<string>',
'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' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kycaml.frankiefinancial.io/transaction/v2/transactions"
payload := strings.NewReader("{\n \"riskToken\": {\n \"sessionKey\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"transactionId\": \"<string>\",\n \"customer\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n },\n \"activity\": {\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"customerTransaction\": {\n \"paymentId\": \"<string>\",\n \"paymentAmount\": 123,\n \"currencyCode\": \"<string>\",\n \"accountPan\": \"<string>\",\n \"paymentDesc\": \"<string>\",\n \"paymentStatus\": \"<string>\",\n \"order\": {\n \"prevOrderCount\": 123,\n \"lastOrderDate\": \"1983-04-22\",\n \"orderChannel\": \"<string>\",\n \"prevUnpaidOrderCount\": 123\n },\n \"merchant\": {\n \"id\": \"<string>\",\n \"mcc\": \"<string>\",\n \"category\": \"<string>\"\n },\n \"hashedPan\": \"<string>\",\n \"maskedPan\": \"<string>\",\n \"accountRoute\": \"<string>\",\n \"accountIban\": \"<string>\",\n \"accountSwift\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountExtId\": \"<string>\",\n \"extraData\": {}\n },\n \"counterParty\": {\n \"partyDetails\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n }\n }\n },\n \"checkId\": \"<string>\",\n \"device\": {\n \"id\": \"<string>\",\n \"origin\": \"<string>\",\n \"os\": \"<string>\",\n \"browser\": \"<string>\",\n \"platform\": \"<string>\",\n \"riskScore\": 123,\n \"ip\": \"127.0.0.1\",\n \"ipGeoAsn\": \"<string>\",\n \"ipGeoCity\": \"<string>\",\n \"ipGeoCountry\": \"<string>\",\n \"ipGeoLat\": \"<string>\",\n \"ipGeoLong\": \"<string>\",\n \"isBot\": true,\n \"isRat\": true,\n \"isMobileBot\": true,\n \"isRecentRat\": true,\n \"isSupported\": true,\n \"isEmulated\": true,\n \"session\": \"<string>\",\n \"activity\": \"<string>\",\n \"extraData\": {}\n },\n \"extraData\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("apiKey", "<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.kycaml.frankiefinancial.io/transaction/v2/transactions")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"riskToken\": {\n \"sessionKey\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"transactionId\": \"<string>\",\n \"customer\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n },\n \"activity\": {\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"customerTransaction\": {\n \"paymentId\": \"<string>\",\n \"paymentAmount\": 123,\n \"currencyCode\": \"<string>\",\n \"accountPan\": \"<string>\",\n \"paymentDesc\": \"<string>\",\n \"paymentStatus\": \"<string>\",\n \"order\": {\n \"prevOrderCount\": 123,\n \"lastOrderDate\": \"1983-04-22\",\n \"orderChannel\": \"<string>\",\n \"prevUnpaidOrderCount\": 123\n },\n \"merchant\": {\n \"id\": \"<string>\",\n \"mcc\": \"<string>\",\n \"category\": \"<string>\"\n },\n \"hashedPan\": \"<string>\",\n \"maskedPan\": \"<string>\",\n \"accountRoute\": \"<string>\",\n \"accountIban\": \"<string>\",\n \"accountSwift\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountExtId\": \"<string>\",\n \"extraData\": {}\n },\n \"counterParty\": {\n \"partyDetails\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n }\n }\n },\n \"checkId\": \"<string>\",\n \"device\": {\n \"id\": \"<string>\",\n \"origin\": \"<string>\",\n \"os\": \"<string>\",\n \"browser\": \"<string>\",\n \"platform\": \"<string>\",\n \"riskScore\": 123,\n \"ip\": \"127.0.0.1\",\n \"ipGeoAsn\": \"<string>\",\n \"ipGeoCity\": \"<string>\",\n \"ipGeoCountry\": \"<string>\",\n \"ipGeoLat\": \"<string>\",\n \"ipGeoLong\": \"<string>\",\n \"isBot\": true,\n \"isRat\": true,\n \"isMobileBot\": true,\n \"isRecentRat\": true,\n \"isSupported\": true,\n \"isEmulated\": true,\n \"session\": \"<string>\",\n \"activity\": \"<string>\",\n \"extraData\": {}\n },\n \"extraData\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/transaction/v2/transactions")
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["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"riskToken\": {\n \"sessionKey\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"transactionId\": \"<string>\",\n \"customer\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n },\n \"activity\": {\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"customerTransaction\": {\n \"paymentId\": \"<string>\",\n \"paymentAmount\": 123,\n \"currencyCode\": \"<string>\",\n \"accountPan\": \"<string>\",\n \"paymentDesc\": \"<string>\",\n \"paymentStatus\": \"<string>\",\n \"order\": {\n \"prevOrderCount\": 123,\n \"lastOrderDate\": \"1983-04-22\",\n \"orderChannel\": \"<string>\",\n \"prevUnpaidOrderCount\": 123\n },\n \"merchant\": {\n \"id\": \"<string>\",\n \"mcc\": \"<string>\",\n \"category\": \"<string>\"\n },\n \"hashedPan\": \"<string>\",\n \"maskedPan\": \"<string>\",\n \"accountRoute\": \"<string>\",\n \"accountIban\": \"<string>\",\n \"accountSwift\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountExtId\": \"<string>\",\n \"extraData\": {}\n },\n \"counterParty\": {\n \"partyDetails\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n }\n }\n },\n \"checkId\": \"<string>\",\n \"device\": {\n \"id\": \"<string>\",\n \"origin\": \"<string>\",\n \"os\": \"<string>\",\n \"browser\": \"<string>\",\n \"platform\": \"<string>\",\n \"riskScore\": 123,\n \"ip\": \"127.0.0.1\",\n \"ipGeoAsn\": \"<string>\",\n \"ipGeoCity\": \"<string>\",\n \"ipGeoCountry\": \"<string>\",\n \"ipGeoLat\": \"<string>\",\n \"ipGeoLong\": \"<string>\",\n \"isBot\": true,\n \"isRat\": true,\n \"isMobileBot\": true,\n \"isRecentRat\": true,\n \"isSupported\": true,\n \"isEmulated\": true,\n \"session\": \"<string>\",\n \"activity\": \"<string>\",\n \"extraData\": {}\n },\n \"extraData\": {}\n}"
response = http.request(request)
puts response.read_body{
"customerReference": "<string>",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"checkId": "7eb4432d-398b-40f7-b24b-7d1208b83e2a",
"transactionId": "df609f14-b34d-46ad-bf15-09c5f71dda8d",
"riskScore": 123,
"riskLevel": "MEDIUM",
"riskResults": [
{
"id": "<string>",
"riskScore": 123,
"riskLevel": "MEDIUM",
"indicators": [
{
"name": "<string>",
"id": "<string>",
"score": 123,
"value": "<string>",
"rules": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"actions": [
{
"id": "<string>",
"value": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"type": "<string>"
}
]
}
],
"source": "<string>",
"sourceLink": "<string>",
"extraData": {}
}
],
"extraData": {},
"errors": {
"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"
}
]
}
}{
"requestId": "<string>"
}{
"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"
}
]
}{
"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"
}
]
}Transactions
Check a transaction's risk
Evaluate customer activity for fraud risk and/or money laundering risk. Fraud risk may be associated with the customer or their device as well as the transactions that they performed. Money laundering risk is associated with financial transactions.
You supply the details of the action or transaction, originator/customer and beneficiary/counter-party, along with any additional data such as device details, location information and any additional data you feel might be relevant.
This API is extremely flexible and can be extended easily - please contact your FrankieOne account manager to discuss your options.
Note: When performing a risk check for a Crypto activity type (CRYPTO_WITHDRAWAL, CRYPTO_DEPOSIT) you can provide additional information for the evaluated exchange value of the coin and value in the transaction. This can be provided by adding a payment.alternative.value and payment.alternative.currencyCode in the activity.customerTransaction.extraData field.
For example:
{
...
"extraData": {
"payment.alternative.value": "10000.00",
"payment.alternative.currencyCode": "USD"
}
...
}
POST
/
transactions
Check a transaction's risk
curl --request POST \
--url https://api.kycaml.frankiefinancial.io/transaction/v2/transactions \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'apiKey: <api-key>' \
--data '
{
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"activity": {
"timestamp": "2023-11-07T05:31:56Z",
"customerTransaction": {
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountExtId": "<string>",
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"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": {}
}
'import requests
url = "https://api.kycaml.frankiefinancial.io/transaction/v2/transactions"
payload = {
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"extraData": {}
},
"activity": {
"timestamp": "2023-11-07T05:31:56Z",
"customerTransaction": {
"paymentId": "<string>",
"paymentAmount": 123,
"currencyCode": "<string>",
"accountPan": "<string>",
"paymentDesc": "<string>",
"paymentStatus": "<string>",
"order": {
"prevOrderCount": 123,
"lastOrderDate": "1983-04-22",
"orderChannel": "<string>",
"prevUnpaidOrderCount": 123
},
"merchant": {
"id": "<string>",
"mcc": "<string>",
"category": "<string>"
},
"hashedPan": "<string>",
"maskedPan": "<string>",
"accountRoute": "<string>",
"accountIban": "<string>",
"accountSwift": "<string>",
"accountName": "<string>",
"accountExtId": "<string>",
"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",
"email": "<string>",
"phone": "<string>",
"nationalId": "<string>",
"companyName": "<string>",
"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": {}
}
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"apiKey": "<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>',
apiKey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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',
email: '<string>',
phone: '<string>',
nationalId: '<string>',
companyName: '<string>',
extraData: {}
},
activity: {
timestamp: '2023-11-07T05:31:56Z',
customerTransaction: {
paymentId: '<string>',
paymentAmount: 123,
currencyCode: '<string>',
accountPan: '<string>',
paymentDesc: '<string>',
paymentStatus: '<string>',
order: {
prevOrderCount: 123,
lastOrderDate: '1983-04-22',
orderChannel: '<string>',
prevUnpaidOrderCount: 123
},
merchant: {id: '<string>', mcc: '<string>', category: '<string>'},
hashedPan: '<string>',
maskedPan: '<string>',
accountRoute: '<string>',
accountIban: '<string>',
accountSwift: '<string>',
accountName: '<string>',
accountExtId: '<string>',
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',
email: '<string>',
phone: '<string>',
nationalId: '<string>',
companyName: '<string>',
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: {}
})
};
fetch('https://api.kycaml.frankiefinancial.io/transaction/v2/transactions', 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/transactions",
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([
'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',
'email' => '<string>',
'phone' => '<string>',
'nationalId' => '<string>',
'companyName' => '<string>',
'extraData' => [
]
],
'activity' => [
'timestamp' => '2023-11-07T05:31:56Z',
'customerTransaction' => [
'paymentId' => '<string>',
'paymentAmount' => 123,
'currencyCode' => '<string>',
'accountPan' => '<string>',
'paymentDesc' => '<string>',
'paymentStatus' => '<string>',
'order' => [
'prevOrderCount' => 123,
'lastOrderDate' => '1983-04-22',
'orderChannel' => '<string>',
'prevUnpaidOrderCount' => 123
],
'merchant' => [
'id' => '<string>',
'mcc' => '<string>',
'category' => '<string>'
],
'hashedPan' => '<string>',
'maskedPan' => '<string>',
'accountRoute' => '<string>',
'accountIban' => '<string>',
'accountSwift' => '<string>',
'accountName' => '<string>',
'accountExtId' => '<string>',
'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',
'email' => '<string>',
'phone' => '<string>',
'nationalId' => '<string>',
'companyName' => '<string>',
'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' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kycaml.frankiefinancial.io/transaction/v2/transactions"
payload := strings.NewReader("{\n \"riskToken\": {\n \"sessionKey\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"transactionId\": \"<string>\",\n \"customer\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n },\n \"activity\": {\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"customerTransaction\": {\n \"paymentId\": \"<string>\",\n \"paymentAmount\": 123,\n \"currencyCode\": \"<string>\",\n \"accountPan\": \"<string>\",\n \"paymentDesc\": \"<string>\",\n \"paymentStatus\": \"<string>\",\n \"order\": {\n \"prevOrderCount\": 123,\n \"lastOrderDate\": \"1983-04-22\",\n \"orderChannel\": \"<string>\",\n \"prevUnpaidOrderCount\": 123\n },\n \"merchant\": {\n \"id\": \"<string>\",\n \"mcc\": \"<string>\",\n \"category\": \"<string>\"\n },\n \"hashedPan\": \"<string>\",\n \"maskedPan\": \"<string>\",\n \"accountRoute\": \"<string>\",\n \"accountIban\": \"<string>\",\n \"accountSwift\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountExtId\": \"<string>\",\n \"extraData\": {}\n },\n \"counterParty\": {\n \"partyDetails\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n }\n }\n },\n \"checkId\": \"<string>\",\n \"device\": {\n \"id\": \"<string>\",\n \"origin\": \"<string>\",\n \"os\": \"<string>\",\n \"browser\": \"<string>\",\n \"platform\": \"<string>\",\n \"riskScore\": 123,\n \"ip\": \"127.0.0.1\",\n \"ipGeoAsn\": \"<string>\",\n \"ipGeoCity\": \"<string>\",\n \"ipGeoCountry\": \"<string>\",\n \"ipGeoLat\": \"<string>\",\n \"ipGeoLong\": \"<string>\",\n \"isBot\": true,\n \"isRat\": true,\n \"isMobileBot\": true,\n \"isRecentRat\": true,\n \"isSupported\": true,\n \"isEmulated\": true,\n \"session\": \"<string>\",\n \"activity\": \"<string>\",\n \"extraData\": {}\n },\n \"extraData\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("apiKey", "<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.kycaml.frankiefinancial.io/transaction/v2/transactions")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"riskToken\": {\n \"sessionKey\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"transactionId\": \"<string>\",\n \"customer\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n },\n \"activity\": {\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"customerTransaction\": {\n \"paymentId\": \"<string>\",\n \"paymentAmount\": 123,\n \"currencyCode\": \"<string>\",\n \"accountPan\": \"<string>\",\n \"paymentDesc\": \"<string>\",\n \"paymentStatus\": \"<string>\",\n \"order\": {\n \"prevOrderCount\": 123,\n \"lastOrderDate\": \"1983-04-22\",\n \"orderChannel\": \"<string>\",\n \"prevUnpaidOrderCount\": 123\n },\n \"merchant\": {\n \"id\": \"<string>\",\n \"mcc\": \"<string>\",\n \"category\": \"<string>\"\n },\n \"hashedPan\": \"<string>\",\n \"maskedPan\": \"<string>\",\n \"accountRoute\": \"<string>\",\n \"accountIban\": \"<string>\",\n \"accountSwift\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountExtId\": \"<string>\",\n \"extraData\": {}\n },\n \"counterParty\": {\n \"partyDetails\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n }\n }\n },\n \"checkId\": \"<string>\",\n \"device\": {\n \"id\": \"<string>\",\n \"origin\": \"<string>\",\n \"os\": \"<string>\",\n \"browser\": \"<string>\",\n \"platform\": \"<string>\",\n \"riskScore\": 123,\n \"ip\": \"127.0.0.1\",\n \"ipGeoAsn\": \"<string>\",\n \"ipGeoCity\": \"<string>\",\n \"ipGeoCountry\": \"<string>\",\n \"ipGeoLat\": \"<string>\",\n \"ipGeoLong\": \"<string>\",\n \"isBot\": true,\n \"isRat\": true,\n \"isMobileBot\": true,\n \"isRecentRat\": true,\n \"isSupported\": true,\n \"isEmulated\": true,\n \"session\": \"<string>\",\n \"activity\": \"<string>\",\n \"extraData\": {}\n },\n \"extraData\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/transaction/v2/transactions")
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["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"riskToken\": {\n \"sessionKey\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"transactionId\": \"<string>\",\n \"customer\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n },\n \"activity\": {\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"customerTransaction\": {\n \"paymentId\": \"<string>\",\n \"paymentAmount\": 123,\n \"currencyCode\": \"<string>\",\n \"accountPan\": \"<string>\",\n \"paymentDesc\": \"<string>\",\n \"paymentStatus\": \"<string>\",\n \"order\": {\n \"prevOrderCount\": 123,\n \"lastOrderDate\": \"1983-04-22\",\n \"orderChannel\": \"<string>\",\n \"prevUnpaidOrderCount\": 123\n },\n \"merchant\": {\n \"id\": \"<string>\",\n \"mcc\": \"<string>\",\n \"category\": \"<string>\"\n },\n \"hashedPan\": \"<string>\",\n \"maskedPan\": \"<string>\",\n \"accountRoute\": \"<string>\",\n \"accountIban\": \"<string>\",\n \"accountSwift\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountExtId\": \"<string>\",\n \"extraData\": {}\n },\n \"counterParty\": {\n \"partyDetails\": {\n \"customerId\": \"<string>\",\n \"customerType\": \"<string>\",\n \"dataSource\": \"<string>\",\n \"productType\": \"<string>\",\n \"entityId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"frankieId\": \"98ded7ac-2457-4bde-b27c-fcee05301262\",\n \"createdDatetime\": \"2023-11-07T05:31:56Z\",\n \"firstName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"dob\": \"1983-04-22\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"nationalId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"extraData\": {}\n }\n }\n },\n \"checkId\": \"<string>\",\n \"device\": {\n \"id\": \"<string>\",\n \"origin\": \"<string>\",\n \"os\": \"<string>\",\n \"browser\": \"<string>\",\n \"platform\": \"<string>\",\n \"riskScore\": 123,\n \"ip\": \"127.0.0.1\",\n \"ipGeoAsn\": \"<string>\",\n \"ipGeoCity\": \"<string>\",\n \"ipGeoCountry\": \"<string>\",\n \"ipGeoLat\": \"<string>\",\n \"ipGeoLong\": \"<string>\",\n \"isBot\": true,\n \"isRat\": true,\n \"isMobileBot\": true,\n \"isRecentRat\": true,\n \"isSupported\": true,\n \"isEmulated\": true,\n \"session\": \"<string>\",\n \"activity\": \"<string>\",\n \"extraData\": {}\n },\n \"extraData\": {}\n}"
response = http.request(request)
puts response.read_body{
"customerReference": "<string>",
"entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
"checkId": "7eb4432d-398b-40f7-b24b-7d1208b83e2a",
"transactionId": "df609f14-b34d-46ad-bf15-09c5f71dda8d",
"riskScore": 123,
"riskLevel": "MEDIUM",
"riskResults": [
{
"id": "<string>",
"riskScore": 123,
"riskLevel": "MEDIUM",
"indicators": [
{
"name": "<string>",
"id": "<string>",
"score": 123,
"value": "<string>",
"rules": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"actions": [
{
"id": "<string>",
"value": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"type": "<string>"
}
]
}
],
"source": "<string>",
"sourceLink": "<string>",
"extraData": {}
}
],
"extraData": {},
"errors": {
"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"
}
]
}
}{
"requestId": "<string>"
}{
"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"
}
]
}{
"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"
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.
Available options:
0, 1 Body
application/json
A recorded activity that is/has been assessed by the Transaction Monitoring Service
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 transaction monitoring check, should be unique per transaction
A party describes the details of one of the parties in a given assessment. It can be used to describe any participant.
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
(Deprecated in favor of transactionId)
Wrapper that will contain additional device data for a given transaction. This may be captured through 3rd party services
Show child attributes
Show child attributes
A generic map of Key/Value's that can be used to define custom properties.
Response
The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.
The resulting payload from a transaction risk check request.
The customer's reference value
The overall result of the transaction check, this will be based on the successful completion of a check to an upstream vendor for the transaction check
Available options:
SUCCESS, SUCCESS_WITH_ERRORS, FAILED The unique identifier for a FrankieOne entity construct
Example:
"98ded7ac-2457-4bde-b27c-fcee05301262"
The unique identifier for a transaction monitoring check that was execute for a transaction
Example:
"7eb4432d-398b-40f7-b24b-7d1208b83e2a"
The unique identifier of a transaction as identified within the FrankieOne Transaction Monitoring system
Example:
"df609f14-b34d-46ad-bf15-09c5f71dda8d"
Risk score as determined by the checking service
Level of risk as determined by the service.
Available options:
NONE, LOW, MEDIUM, HIGH, VERY_HIGH Example:
"MEDIUM"
All the result sets available for the check, such as customer, device, and transaction
Show child attributes
Show child attributes
A generic map of Key/Value's that can be used to define custom properties.
Show child attributes
Show child attributes
Was this page helpful?
⌘I