Skip to main content
GET
/
v2
/
individuals
/
{entityId}
/
activities
Get Individual Activities
curl --request GET \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/activities \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "activities": [
    {
      "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>"
          }
        ]
      }
    }
  ],
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "meta": {
    "page": 123,
    "total": 123,
    "limit": 123,
    "count": 123
  }
}

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]"

Path Parameters

​
entityId
string
required

Unique identifier for an entity Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Query Parameters

​
activityTypes
enum<string>[]

Query parameter to filter activities by types

The different types of activities able to be monitored

Available options:
TRANSACTION,
EVENT
​
activityResultClasses
enum<string>[]

Query parameter to filter results by classes

The class of the activity result (AML, FRAUD, EVENT)

Available options:
AML,
FRAUD,
EVENT
​
sortField
enum<string>
default:ACTIVITY_AT

Query parameter to determine which fields specific field to sort by.

Available options:
ACTIVITY_AT
​
sort
enum<string>
default:DESC

The order in which your results will display.

This is to be used in conjunction with sortField.

If there are multiple matches for the same value, the results will be sorted by the primary identifier (e.g. activityId).

Sort records by a specific field in a specific direction. This is to be used in conjunction with sortBy.

  • DESC: Descending order (default)
  • ASC: Ascending order
Available options:
ASC,
DESC
​
limit
integer
default:20

Query parameter to limit the number of records returned

Required range: 1 <= x <= 200
​
page
integer
default:1

Query parameter to paginate through returned items

Required range: x >= 1
​
afterActivityAt
string<date-time>

Query parameter to filter records after a specific activity timestamp. Timestamp values must be in UTC ISO8601 format.

​
beforeActivityAt
string<date-time>

Query parameter to filter records that occurred before a specific activity timestamp. Timestamp values must be in UTC ISO8601 format.

Response

OK

Response object for getting summary and overview of activities

​
activities
object[]
required
​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
meta
object
required

Meta information about the request and response