Skip to main content
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",
      "entityType": "INDIVIDUAL",
      "externalReference": {
        "name": "CUSTOMER-REFERENCE",
        "value": "CUST-00001342",
        "type": "CUSTOMER",
        "description": "This is the customer ID in the core banking system."
      },
      "individual": {
        "name": {
          "familyName": "Doe",
          "language": "eng",
          "givenName": "John",
          "middleName": "R",
          "otherName": null,
          "prefix": "Dr.",
          "suffix": "Jr.",
          "displayName": "John Doe"
        },
        "dateOfBirth": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN"
        }
      },
      "organization": {
        "sourceId": "<string>",
        "registeredName": "<string>",
        "registeredSubdivision": "<string>",
        "registeredCountry": "<string>",
        "registrationNumber": "<string>",
        "registrationNumberType": "<string>",
        "registrationNumberDescription": "<string>"
      },
      "entityName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "addresses": [
        {
          "country": "<string>",
          "addressId": "<string>",
          "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>"
        }
      ],
      "emailAddresses": [
        {
          "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
          "type": "WORK",
          "email": "[email protected]",
          "isPreferred": true
        }
      ]
    },
    "detail": {
      "activityType": "TRANSACTION",
      "eventType": "LOGIN",
      "customAttributes": {},
      "activityAt": "2023-11-07T05:31:56Z"
    },
    "session": {
      "token": "<string>"
    }
  }
}
'
{
  "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",
        "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"
        },
        "dateOfBirth": {
          "dateOfBirthId": "<string>",
          "sourceId": "<string>",
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN",
          "normalized": "1990-03-31"
        }
      },
      "organization": {
        "sourceId": "<string>",
        "registeredName": "<string>",
        "registeredSubdivision": "<string>",
        "registeredCountry": "<string>",
        "registrationNumber": "<string>",
        "registrationNumberType": "<string>",
        "registrationNumberDescription": "<string>"
      },
      "entityName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "addresses": [
        {
          "country": "<string>",
          "addressId": "<string>",
          "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>"
        }
      ],
      "emailAddresses": [
        {
          "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
          "type": "WORK",
          "sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
          "email": "[email protected]",
          "isPreferred": true,
          "linkedAddresses": [
            {
              "addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
            }
          ]
        }
      ]
    },
    "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
      },
      "isRat": true,
      "isSupported": true,
      "isEmulated": true,
      "isRooted": true,
      "reputation": "<string>",
      "vpnLikelihood": "LOW",
      "proxyLikelihood": "LOW",
      "botLikelihood": "LOW",
      "deviceId": "<string>",
      "sourceId": "<string>",
      "providerName": "<string>",
      "externalIdentifiers": [
        {
          "name": "CUSTOMER-REFERENCE",
          "value": "CUST-00001342",
          "description": "This is the customer ID in the core banking system."
        }
      ],
      "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>",
    "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_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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

​
X-Frankie-Username
string

Username provided by API caller

Example:

"[email protected]"

Body

application/json
​
activity
object
required

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 Session API. 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.

Response

OK

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
activity
object
required

Activity details