Evaluate an activity
curl --request POST \
--url https://api.uat.frankie.one/v2/activities \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"activity": {
"party": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"individual": {
"dateOfBirth": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
}
},
"organization": {
"sourceId": "<string>",
"registeredName": "<string>"
},
"entityName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customAttributes": {},
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"country": "AUS",
"number": "0426192340",
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"email": "leonardo_dc@outlook.com",
"isPreferred": true,
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"detail": {
"customAttributes": {},
"activityAt": "2023-11-07T05:31:56Z"
},
"session": {
"token": "<string>"
},
"device": {
"ipAddressInformation": {
"v4Address": "127.0.0.1",
"v6Address": "2606:4700:3108::ac42:2835"
}
}
}
}
'import requests
url = "https://api.uat.frankie.one/v2/activities"
payload = { "activity": {
"party": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"individual": { "dateOfBirth": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
} },
"organization": {
"sourceId": "<string>",
"registeredName": "<string>"
},
"entityName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customAttributes": {},
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": True,
"type": "MOBILE",
"country": "AUS",
"number": "0426192340",
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"email": "leonardo_dc@outlook.com",
"isPreferred": True,
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"detail": {
"customAttributes": {},
"activityAt": "2023-11-07T05:31:56Z"
},
"session": { "token": "<string>" },
"device": { "ipAddressInformation": {
"v4Address": "127.0.0.1",
"v6Address": "2606:4700:3108::ac42:2835"
} }
} }
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({
activity: {
party: {
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
individual: {
dateOfBirth: {
year: '1990',
month: '03',
day: '27',
unstructured: '12 Rajab 1445 AH',
type: 'GREGORIAN'
}
},
organization: {sourceId: '<string>', registeredName: '<string>'},
entityName: '<string>',
createdAt: '2023-11-07T05:31:56Z',
customAttributes: {},
addresses: [
{
country: '<string>',
addressId: '<string>',
updatedAt: '2023-11-07T05:31:56Z',
type: 'OTHER',
typeDescription: '<string>',
validFrom: {
year: '1990',
month: '03',
day: '27',
unstructured: '12 Rajab 1445 AH',
type: 'GREGORIAN'
},
validTo: {
year: '1990',
month: '03',
day: '27',
unstructured: '12 Rajab 1445 AH',
type: 'GREGORIAN'
},
longForm: '<string>',
unitNumber: '<string>',
buildingName: '<string>',
streetName: '<string>',
streetNumber: '<string>',
streetType: '<string>',
neighborhood: '<string>',
locality: '<string>',
district: '<string>',
subdivision: '<string>',
postalCode: '<string>',
careOf: '<string>',
status: 'CURRENT'
}
],
phoneNumbers: [
{
phoneNumberId: 'ad165f64-5717-4562-b3fc-2c963f66bfa9',
isPreferred: true,
type: 'MOBILE',
country: 'AUS',
number: '0426192340',
unstructuredLongForm: '<string>',
updatedAt: '2023-11-07T05:31:56Z'
}
],
emailAddresses: [
{
emailAddressId: 'aa385f64-5717-4562-b3fc-2c963f66af21',
type: 'WORK',
email: 'leonardo_dc@outlook.com',
isPreferred: true,
updatedAt: '2023-11-07T05:31:56Z'
}
]
},
detail: {customAttributes: {}, activityAt: '2023-11-07T05:31:56Z'},
session: {token: '<string>'},
device: {
ipAddressInformation: {v4Address: '127.0.0.1', v6Address: '2606:4700:3108::ac42:2835'}
}
}
})
};
fetch('https://api.uat.frankie.one/v2/activities', 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/activities",
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([
'activity' => [
'party' => [
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'individual' => [
'dateOfBirth' => [
'year' => '1990',
'month' => '03',
'day' => '27',
'unstructured' => '12 Rajab 1445 AH',
'type' => 'GREGORIAN'
]
],
'organization' => [
'sourceId' => '<string>',
'registeredName' => '<string>'
],
'entityName' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'customAttributes' => [
],
'addresses' => [
[
'country' => '<string>',
'addressId' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z',
'type' => 'OTHER',
'typeDescription' => '<string>',
'validFrom' => [
'year' => '1990',
'month' => '03',
'day' => '27',
'unstructured' => '12 Rajab 1445 AH',
'type' => 'GREGORIAN'
],
'validTo' => [
'year' => '1990',
'month' => '03',
'day' => '27',
'unstructured' => '12 Rajab 1445 AH',
'type' => 'GREGORIAN'
],
'longForm' => '<string>',
'unitNumber' => '<string>',
'buildingName' => '<string>',
'streetName' => '<string>',
'streetNumber' => '<string>',
'streetType' => '<string>',
'neighborhood' => '<string>',
'locality' => '<string>',
'district' => '<string>',
'subdivision' => '<string>',
'postalCode' => '<string>',
'careOf' => '<string>',
'status' => 'CURRENT'
]
],
'phoneNumbers' => [
[
'phoneNumberId' => 'ad165f64-5717-4562-b3fc-2c963f66bfa9',
'isPreferred' => true,
'type' => 'MOBILE',
'country' => 'AUS',
'number' => '0426192340',
'unstructuredLongForm' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z'
]
],
'emailAddresses' => [
[
'emailAddressId' => 'aa385f64-5717-4562-b3fc-2c963f66af21',
'type' => 'WORK',
'email' => 'leonardo_dc@outlook.com',
'isPreferred' => true,
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
],
'detail' => [
'customAttributes' => [
],
'activityAt' => '2023-11-07T05:31:56Z'
],
'session' => [
'token' => '<string>'
],
'device' => [
'ipAddressInformation' => [
'v4Address' => '127.0.0.1',
'v6Address' => '2606:4700:3108::ac42:2835'
]
]
]
]),
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/activities"
payload := strings.NewReader("{\n \"activity\": {\n \"party\": {\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"individual\": {\n \"dateOfBirth\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n }\n },\n \"organization\": {\n \"sourceId\": \"<string>\",\n \"registeredName\": \"<string>\"\n },\n \"entityName\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"customAttributes\": {},\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"addressId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"type\": \"OTHER\",\n \"typeDescription\": \"<string>\",\n \"validFrom\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"validTo\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"longForm\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"locality\": \"<string>\",\n \"district\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"careOf\": \"<string>\",\n \"status\": \"CURRENT\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"ad165f64-5717-4562-b3fc-2c963f66bfa9\",\n \"isPreferred\": true,\n \"type\": \"MOBILE\",\n \"country\": \"AUS\",\n \"number\": \"0426192340\",\n \"unstructuredLongForm\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"aa385f64-5717-4562-b3fc-2c963f66af21\",\n \"type\": \"WORK\",\n \"email\": \"leonardo_dc@outlook.com\",\n \"isPreferred\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"detail\": {\n \"customAttributes\": {},\n \"activityAt\": \"2023-11-07T05:31:56Z\"\n },\n \"session\": {\n \"token\": \"<string>\"\n },\n \"device\": {\n \"ipAddressInformation\": {\n \"v4Address\": \"127.0.0.1\",\n \"v6Address\": \"2606:4700:3108::ac42:2835\"\n }\n }\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/activities")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"activity\": {\n \"party\": {\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"individual\": {\n \"dateOfBirth\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n }\n },\n \"organization\": {\n \"sourceId\": \"<string>\",\n \"registeredName\": \"<string>\"\n },\n \"entityName\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"customAttributes\": {},\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"addressId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"type\": \"OTHER\",\n \"typeDescription\": \"<string>\",\n \"validFrom\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"validTo\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"longForm\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"locality\": \"<string>\",\n \"district\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"careOf\": \"<string>\",\n \"status\": \"CURRENT\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"ad165f64-5717-4562-b3fc-2c963f66bfa9\",\n \"isPreferred\": true,\n \"type\": \"MOBILE\",\n \"country\": \"AUS\",\n \"number\": \"0426192340\",\n \"unstructuredLongForm\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"aa385f64-5717-4562-b3fc-2c963f66af21\",\n \"type\": \"WORK\",\n \"email\": \"leonardo_dc@outlook.com\",\n \"isPreferred\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"detail\": {\n \"customAttributes\": {},\n \"activityAt\": \"2023-11-07T05:31:56Z\"\n },\n \"session\": {\n \"token\": \"<string>\"\n },\n \"device\": {\n \"ipAddressInformation\": {\n \"v4Address\": \"127.0.0.1\",\n \"v6Address\": \"2606:4700:3108::ac42:2835\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/activities")
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 \"activity\": {\n \"party\": {\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"individual\": {\n \"dateOfBirth\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n }\n },\n \"organization\": {\n \"sourceId\": \"<string>\",\n \"registeredName\": \"<string>\"\n },\n \"entityName\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"customAttributes\": {},\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"addressId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"type\": \"OTHER\",\n \"typeDescription\": \"<string>\",\n \"validFrom\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"validTo\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"longForm\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"locality\": \"<string>\",\n \"district\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"careOf\": \"<string>\",\n \"status\": \"CURRENT\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"ad165f64-5717-4562-b3fc-2c963f66bfa9\",\n \"isPreferred\": true,\n \"type\": \"MOBILE\",\n \"country\": \"AUS\",\n \"number\": \"0426192340\",\n \"unstructuredLongForm\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"aa385f64-5717-4562-b3fc-2c963f66af21\",\n \"type\": \"WORK\",\n \"email\": \"leonardo_dc@outlook.com\",\n \"isPreferred\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"detail\": {\n \"customAttributes\": {},\n \"activityAt\": \"2023-11-07T05:31:56Z\"\n },\n \"session\": {\n \"token\": \"<string>\"\n },\n \"device\": {\n \"ipAddressInformation\": {\n \"v4Address\": \"127.0.0.1\",\n \"v6Address\": \"2606:4700:3108::ac42:2835\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"activity": {
"party": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"externalReference": {
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
"type": "CUSTOMER",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"description": "This is the customer ID in the core banking system."
},
"individual": {
"name": {
"familyName": "Doe",
"nameId": "87654321-4321-4321-4321-210987654321",
"language": "eng",
"givenName": "John",
"middleName": "R",
"otherName": null,
"prefix": "Dr.",
"suffix": "Jr.",
"sourceId": "87654321-4321-4321-4321-210987654322",
"displayName": "John Doe",
"updatedAt": "2023-11-07T05:31:56Z"
},
"dateOfBirth": {
"dateOfBirthId": "<string>",
"sourceId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
},
"organization": {
"sourceId": "<string>",
"registeredName": "<string>"
},
"entityName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customAttributes": {},
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
],
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "leonardo_dc@outlook.com",
"isPreferred": true,
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"riskSignals": {
"email": "UNKNOWN",
"emailDomain": "UNKNOWN",
"address": "UNKNOWN",
"phone": "UNKNOWN"
}
},
"detail": {
"activityType": "TRANSACTION",
"eventType": "LOGIN",
"customAttributes": {},
"activityAt": "2023-11-07T05:31:56Z"
},
"activityId": "<string>",
"session": {
"token": "<string>"
},
"device": {
"riskScore": 123,
"riskLevel": "UNKNOWN",
"behaviorBiometrics": {
"hesitationPercentileLongTermMemory": 123,
"hesitationPercentileNonLongTermMemory": 123,
"numberDistractionEvents": 123,
"riskLevel": "UNKNOWN"
},
"isRat": true,
"isSupported": true,
"isEmulated": true,
"isRooted": true,
"reputation": "<string>",
"vpnLikelihood": "LOW",
"proxyLikelihood": "LOW",
"botLikelihood": "LOW",
"remoteSoftwareLikelihood": "LOW",
"osAnomaly": "UNKNOWN",
"deviceId": "<string>",
"sourceId": "<string>",
"providerName": "<string>",
"externalIdentifiers": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"description": "This is the customer ID in the core banking system.",
"type": "CUSTOMER",
"metadata": {}
}
],
"os": "<string>",
"trueOs": "<string>",
"firstSeenAt": "2023-11-07T05:31:56Z",
"browser": "<string>",
"platform": "<string>",
"model": "<string>",
"fingerprint": "<string>",
"fingerprintConfidence": 123,
"geolocation": {
"city": [
"Melbourne",
"San Francisco"
],
"country": [
"AUS",
"USA"
],
"subdivision": [
"Victoria",
"California"
],
"latitude": 123,
"longitude": 123
},
"ipAddressInformation": {
"v4Address": "127.0.0.1",
"v6Address": "2606:4700:3108::ac42:2835",
"trueAddress": "<string>",
"asn": "<string>",
"connectionType": [
"Fixed Line ISP"
],
"location": {
"city": [
"Melbourne",
"San Francisco"
],
"country": [
"AUS",
"USA"
],
"subdivision": [
"Victoria",
"California"
],
"latitude": 123,
"longitude": 123
}
},
"createdAt": "2023-11-07T05:31:56Z"
},
"activityRequestId": "<string>",
"relatedProcessResults": [
{
"processResultId": "<string>",
"relatedActivityIds": [
"<string>"
],
"manualStatus": "FALSE_POSITIVE",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"activityResultId": "<string>",
"class": "AML"
}
],
"schemaVersion": 2,
"evaluation": {
"lastUpdatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"evaluatedAt": "2023-11-07T05:31:56Z",
"evaluationId": "<string>",
"activityResults": [
{
"activityResultId": "<string>",
"processResultId": "<string>",
"class": "AML",
"riskLevel": "UNKNOWN",
"manualStatus": "FALSE_POSITIVE",
"indicators": [
{
"indicatorId": "<string>",
"name": "<string>",
"value": "<string>",
"score": "<string>",
"rules": [
{
"ruleId": "<string>",
"reference": "Rule-12345",
"name": "<string>",
"description": "<string>",
"isActive": true
}
]
}
],
"reference": {
"name": "<string>",
"type": "URL",
"reference": "<string>"
},
"serviceProvider": "<string>"
}
]
}
}
}Activities
Evaluate an activity
Evaluate an activity. This may be verification of a financial transaction such as a deposit, withdrawal, etc or evaluating a platform level login or registration activities for example.
An entity must exist in the frankie system to tie the activity to.
This will return the immediate result of the activity, and then asynchronously the activity will be processed in the FrankieOne platform.
POST
/
v2
/
activities
Evaluate an activity
curl --request POST \
--url https://api.uat.frankie.one/v2/activities \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"activity": {
"party": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"individual": {
"dateOfBirth": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
}
},
"organization": {
"sourceId": "<string>",
"registeredName": "<string>"
},
"entityName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customAttributes": {},
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"country": "AUS",
"number": "0426192340",
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"email": "leonardo_dc@outlook.com",
"isPreferred": true,
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"detail": {
"customAttributes": {},
"activityAt": "2023-11-07T05:31:56Z"
},
"session": {
"token": "<string>"
},
"device": {
"ipAddressInformation": {
"v4Address": "127.0.0.1",
"v6Address": "2606:4700:3108::ac42:2835"
}
}
}
}
'import requests
url = "https://api.uat.frankie.one/v2/activities"
payload = { "activity": {
"party": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"individual": { "dateOfBirth": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
} },
"organization": {
"sourceId": "<string>",
"registeredName": "<string>"
},
"entityName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customAttributes": {},
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": True,
"type": "MOBILE",
"country": "AUS",
"number": "0426192340",
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"email": "leonardo_dc@outlook.com",
"isPreferred": True,
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"detail": {
"customAttributes": {},
"activityAt": "2023-11-07T05:31:56Z"
},
"session": { "token": "<string>" },
"device": { "ipAddressInformation": {
"v4Address": "127.0.0.1",
"v6Address": "2606:4700:3108::ac42:2835"
} }
} }
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({
activity: {
party: {
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
individual: {
dateOfBirth: {
year: '1990',
month: '03',
day: '27',
unstructured: '12 Rajab 1445 AH',
type: 'GREGORIAN'
}
},
organization: {sourceId: '<string>', registeredName: '<string>'},
entityName: '<string>',
createdAt: '2023-11-07T05:31:56Z',
customAttributes: {},
addresses: [
{
country: '<string>',
addressId: '<string>',
updatedAt: '2023-11-07T05:31:56Z',
type: 'OTHER',
typeDescription: '<string>',
validFrom: {
year: '1990',
month: '03',
day: '27',
unstructured: '12 Rajab 1445 AH',
type: 'GREGORIAN'
},
validTo: {
year: '1990',
month: '03',
day: '27',
unstructured: '12 Rajab 1445 AH',
type: 'GREGORIAN'
},
longForm: '<string>',
unitNumber: '<string>',
buildingName: '<string>',
streetName: '<string>',
streetNumber: '<string>',
streetType: '<string>',
neighborhood: '<string>',
locality: '<string>',
district: '<string>',
subdivision: '<string>',
postalCode: '<string>',
careOf: '<string>',
status: 'CURRENT'
}
],
phoneNumbers: [
{
phoneNumberId: 'ad165f64-5717-4562-b3fc-2c963f66bfa9',
isPreferred: true,
type: 'MOBILE',
country: 'AUS',
number: '0426192340',
unstructuredLongForm: '<string>',
updatedAt: '2023-11-07T05:31:56Z'
}
],
emailAddresses: [
{
emailAddressId: 'aa385f64-5717-4562-b3fc-2c963f66af21',
type: 'WORK',
email: 'leonardo_dc@outlook.com',
isPreferred: true,
updatedAt: '2023-11-07T05:31:56Z'
}
]
},
detail: {customAttributes: {}, activityAt: '2023-11-07T05:31:56Z'},
session: {token: '<string>'},
device: {
ipAddressInformation: {v4Address: '127.0.0.1', v6Address: '2606:4700:3108::ac42:2835'}
}
}
})
};
fetch('https://api.uat.frankie.one/v2/activities', 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/activities",
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([
'activity' => [
'party' => [
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'individual' => [
'dateOfBirth' => [
'year' => '1990',
'month' => '03',
'day' => '27',
'unstructured' => '12 Rajab 1445 AH',
'type' => 'GREGORIAN'
]
],
'organization' => [
'sourceId' => '<string>',
'registeredName' => '<string>'
],
'entityName' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'customAttributes' => [
],
'addresses' => [
[
'country' => '<string>',
'addressId' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z',
'type' => 'OTHER',
'typeDescription' => '<string>',
'validFrom' => [
'year' => '1990',
'month' => '03',
'day' => '27',
'unstructured' => '12 Rajab 1445 AH',
'type' => 'GREGORIAN'
],
'validTo' => [
'year' => '1990',
'month' => '03',
'day' => '27',
'unstructured' => '12 Rajab 1445 AH',
'type' => 'GREGORIAN'
],
'longForm' => '<string>',
'unitNumber' => '<string>',
'buildingName' => '<string>',
'streetName' => '<string>',
'streetNumber' => '<string>',
'streetType' => '<string>',
'neighborhood' => '<string>',
'locality' => '<string>',
'district' => '<string>',
'subdivision' => '<string>',
'postalCode' => '<string>',
'careOf' => '<string>',
'status' => 'CURRENT'
]
],
'phoneNumbers' => [
[
'phoneNumberId' => 'ad165f64-5717-4562-b3fc-2c963f66bfa9',
'isPreferred' => true,
'type' => 'MOBILE',
'country' => 'AUS',
'number' => '0426192340',
'unstructuredLongForm' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z'
]
],
'emailAddresses' => [
[
'emailAddressId' => 'aa385f64-5717-4562-b3fc-2c963f66af21',
'type' => 'WORK',
'email' => 'leonardo_dc@outlook.com',
'isPreferred' => true,
'updatedAt' => '2023-11-07T05:31:56Z'
]
]
],
'detail' => [
'customAttributes' => [
],
'activityAt' => '2023-11-07T05:31:56Z'
],
'session' => [
'token' => '<string>'
],
'device' => [
'ipAddressInformation' => [
'v4Address' => '127.0.0.1',
'v6Address' => '2606:4700:3108::ac42:2835'
]
]
]
]),
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/activities"
payload := strings.NewReader("{\n \"activity\": {\n \"party\": {\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"individual\": {\n \"dateOfBirth\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n }\n },\n \"organization\": {\n \"sourceId\": \"<string>\",\n \"registeredName\": \"<string>\"\n },\n \"entityName\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"customAttributes\": {},\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"addressId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"type\": \"OTHER\",\n \"typeDescription\": \"<string>\",\n \"validFrom\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"validTo\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"longForm\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"locality\": \"<string>\",\n \"district\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"careOf\": \"<string>\",\n \"status\": \"CURRENT\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"ad165f64-5717-4562-b3fc-2c963f66bfa9\",\n \"isPreferred\": true,\n \"type\": \"MOBILE\",\n \"country\": \"AUS\",\n \"number\": \"0426192340\",\n \"unstructuredLongForm\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"aa385f64-5717-4562-b3fc-2c963f66af21\",\n \"type\": \"WORK\",\n \"email\": \"leonardo_dc@outlook.com\",\n \"isPreferred\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"detail\": {\n \"customAttributes\": {},\n \"activityAt\": \"2023-11-07T05:31:56Z\"\n },\n \"session\": {\n \"token\": \"<string>\"\n },\n \"device\": {\n \"ipAddressInformation\": {\n \"v4Address\": \"127.0.0.1\",\n \"v6Address\": \"2606:4700:3108::ac42:2835\"\n }\n }\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/activities")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"activity\": {\n \"party\": {\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"individual\": {\n \"dateOfBirth\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n }\n },\n \"organization\": {\n \"sourceId\": \"<string>\",\n \"registeredName\": \"<string>\"\n },\n \"entityName\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"customAttributes\": {},\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"addressId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"type\": \"OTHER\",\n \"typeDescription\": \"<string>\",\n \"validFrom\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"validTo\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"longForm\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"locality\": \"<string>\",\n \"district\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"careOf\": \"<string>\",\n \"status\": \"CURRENT\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"ad165f64-5717-4562-b3fc-2c963f66bfa9\",\n \"isPreferred\": true,\n \"type\": \"MOBILE\",\n \"country\": \"AUS\",\n \"number\": \"0426192340\",\n \"unstructuredLongForm\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"aa385f64-5717-4562-b3fc-2c963f66af21\",\n \"type\": \"WORK\",\n \"email\": \"leonardo_dc@outlook.com\",\n \"isPreferred\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"detail\": {\n \"customAttributes\": {},\n \"activityAt\": \"2023-11-07T05:31:56Z\"\n },\n \"session\": {\n \"token\": \"<string>\"\n },\n \"device\": {\n \"ipAddressInformation\": {\n \"v4Address\": \"127.0.0.1\",\n \"v6Address\": \"2606:4700:3108::ac42:2835\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/activities")
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 \"activity\": {\n \"party\": {\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"individual\": {\n \"dateOfBirth\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n }\n },\n \"organization\": {\n \"sourceId\": \"<string>\",\n \"registeredName\": \"<string>\"\n },\n \"entityName\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"customAttributes\": {},\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"addressId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"type\": \"OTHER\",\n \"typeDescription\": \"<string>\",\n \"validFrom\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"validTo\": {\n \"year\": \"1990\",\n \"month\": \"03\",\n \"day\": \"27\",\n \"unstructured\": \"12 Rajab 1445 AH\",\n \"type\": \"GREGORIAN\"\n },\n \"longForm\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"locality\": \"<string>\",\n \"district\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"careOf\": \"<string>\",\n \"status\": \"CURRENT\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumberId\": \"ad165f64-5717-4562-b3fc-2c963f66bfa9\",\n \"isPreferred\": true,\n \"type\": \"MOBILE\",\n \"country\": \"AUS\",\n \"number\": \"0426192340\",\n \"unstructuredLongForm\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"emailAddresses\": [\n {\n \"emailAddressId\": \"aa385f64-5717-4562-b3fc-2c963f66af21\",\n \"type\": \"WORK\",\n \"email\": \"leonardo_dc@outlook.com\",\n \"isPreferred\": true,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"detail\": {\n \"customAttributes\": {},\n \"activityAt\": \"2023-11-07T05:31:56Z\"\n },\n \"session\": {\n \"token\": \"<string>\"\n },\n \"device\": {\n \"ipAddressInformation\": {\n \"v4Address\": \"127.0.0.1\",\n \"v6Address\": \"2606:4700:3108::ac42:2835\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"activity": {
"party": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"externalReference": {
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
"type": "CUSTOMER",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"description": "This is the customer ID in the core banking system."
},
"individual": {
"name": {
"familyName": "Doe",
"nameId": "87654321-4321-4321-4321-210987654321",
"language": "eng",
"givenName": "John",
"middleName": "R",
"otherName": null,
"prefix": "Dr.",
"suffix": "Jr.",
"sourceId": "87654321-4321-4321-4321-210987654322",
"displayName": "John Doe",
"updatedAt": "2023-11-07T05:31:56Z"
},
"dateOfBirth": {
"dateOfBirthId": "<string>",
"sourceId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
},
"organization": {
"sourceId": "<string>",
"registeredName": "<string>"
},
"entityName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customAttributes": {},
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
],
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "leonardo_dc@outlook.com",
"isPreferred": true,
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"riskSignals": {
"email": "UNKNOWN",
"emailDomain": "UNKNOWN",
"address": "UNKNOWN",
"phone": "UNKNOWN"
}
},
"detail": {
"activityType": "TRANSACTION",
"eventType": "LOGIN",
"customAttributes": {},
"activityAt": "2023-11-07T05:31:56Z"
},
"activityId": "<string>",
"session": {
"token": "<string>"
},
"device": {
"riskScore": 123,
"riskLevel": "UNKNOWN",
"behaviorBiometrics": {
"hesitationPercentileLongTermMemory": 123,
"hesitationPercentileNonLongTermMemory": 123,
"numberDistractionEvents": 123,
"riskLevel": "UNKNOWN"
},
"isRat": true,
"isSupported": true,
"isEmulated": true,
"isRooted": true,
"reputation": "<string>",
"vpnLikelihood": "LOW",
"proxyLikelihood": "LOW",
"botLikelihood": "LOW",
"remoteSoftwareLikelihood": "LOW",
"osAnomaly": "UNKNOWN",
"deviceId": "<string>",
"sourceId": "<string>",
"providerName": "<string>",
"externalIdentifiers": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"description": "This is the customer ID in the core banking system.",
"type": "CUSTOMER",
"metadata": {}
}
],
"os": "<string>",
"trueOs": "<string>",
"firstSeenAt": "2023-11-07T05:31:56Z",
"browser": "<string>",
"platform": "<string>",
"model": "<string>",
"fingerprint": "<string>",
"fingerprintConfidence": 123,
"geolocation": {
"city": [
"Melbourne",
"San Francisco"
],
"country": [
"AUS",
"USA"
],
"subdivision": [
"Victoria",
"California"
],
"latitude": 123,
"longitude": 123
},
"ipAddressInformation": {
"v4Address": "127.0.0.1",
"v6Address": "2606:4700:3108::ac42:2835",
"trueAddress": "<string>",
"asn": "<string>",
"connectionType": [
"Fixed Line ISP"
],
"location": {
"city": [
"Melbourne",
"San Francisco"
],
"country": [
"AUS",
"USA"
],
"subdivision": [
"Victoria",
"California"
],
"latitude": 123,
"longitude": 123
}
},
"createdAt": "2023-11-07T05:31:56Z"
},
"activityRequestId": "<string>",
"relatedProcessResults": [
{
"processResultId": "<string>",
"relatedActivityIds": [
"<string>"
],
"manualStatus": "FALSE_POSITIVE",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"activityResultId": "<string>",
"class": "AML"
}
],
"schemaVersion": 2,
"evaluation": {
"lastUpdatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"evaluatedAt": "2023-11-07T05:31:56Z",
"evaluationId": "<string>",
"activityResults": [
{
"activityResultId": "<string>",
"processResultId": "<string>",
"class": "AML",
"riskLevel": "UNKNOWN",
"manualStatus": "FALSE_POSITIVE",
"indicators": [
{
"indicatorId": "<string>",
"name": "<string>",
"value": "<string>",
"score": "<string>",
"rules": [
{
"ruleId": "<string>",
"reference": "Rule-12345",
"name": "<string>",
"description": "<string>",
"isActive": true
}
]
}
],
"reference": {
"name": "<string>",
"type": "URL",
"reference": "<string>"
},
"serviceProvider": "<string>"
}
]
}
}
}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"
Body
application/json
Input data for activity evaluation.
A session token is an identifier that will link together activities done in the same end user session to identify the grouping of activities that belong together. It is represented in FrankieOne as a ULID but can differ if not FrankieOne generated.
The session token may be provided to tie in the activity to a longer running overall session. There are a few options for session tokens:
- A session token may not be provided. It is optional to provide but there must be configuration in your account to allow this - FrankieOne will generate a session token on your behalf to identify the overarching session, you may then use this for further calls for the extent of the service. This is not recommended when device signals are important to your use case.
- A session token generated on the client side and not registered with FrankieOne. The client can generate some sort of unique ID to identify the session and provide that at the time of call and manage the session token for the duration of the session. This can be used when device signals are required.
- A session token can be generated in a seperate API within FrankieOne - Refer to the
Create Individual SessionAPI. This will register the session in FrankieOne and tie it to the individual of interest. There is configuration in your account which can enforce session ownership to avoid clients modifying the session token, adding another layer of security. This can be used when device signals are required.
Show child attributes
Show child attributes
Was this page helpful?