Skip to main content
POST
/
v2
/
activities
/
classify
Classify activities
curl --request POST \
  --url https://api.uat.frankie.one/v2/activities/classify \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "activityIds": [
    "01HN9XHZN6MGXM9JXG50K59Q85",
    "01HN9XHZN6MGXM9JXG50K59Q86"
  ],
  "tagIds": [
    "12345678-1234-1234-1234-123456789012",
    "87654321-4321-4321-4321-210987654321"
  ],
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "mappings": [
    {
      "objectId": "12345678-1234-1234-1234-123456789012",
      "tags": [
        {
          "tagId": "12345678-1234-1234-1234-123456789012",
          "label": "ROMANCE_SCAM",
          "mappingId": "12345678-1234-1234-1234-123456789012",
          "description": "Indicates a potential romance scam.",
          "category": "FRAUD",
          "domain": "ACTIVITY_MONITORING"
        }
      ]
    }
  ]
}

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:

"fred.flintstone@frankieone.com"

Body

application/json

Request to classify one or more activities with tags and optionally provide feedback to the originating provider.

​
entityId
string<uuid>
required

The entity that owns the activities being classified.

Example:

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

​
activityIds
string<ulid>[]
required

IDs of the activities to classify. All activity IDs must exist and belong to the specified entity. If any are invalid or belong to a different tenant the entire request fails with 404 (to prevent data existence leakage).

Minimum array length: 1
Example:
[
  "01HN9XHZN6MGXM9JXG50K59Q85",
  "01HN9XHZN6MGXM9JXG50K59Q86"
]
​
tagIds
string<uuid>[]
required

IDs of tags to apply as classifications to the specified activities. Retrieve available tag IDs via GET /v2/tags (Core V2 API), filtering by relevant categories and domain (e.g. ?categories=FRAUD,MONEY_LAUNDERING,SCAM,TERRORISM_FINANCING,PROLIFERATION_FINANCING&domains=ACTIVITY).

All tags must exist and be accessible to the customer (SYSTEM or owned CUSTOMER tags). Duplicate IDs are silently removed.

Ordering: The first tag in the array is treated as the primary reason when sending feedback to providers that support only a single classification.

Validation rules:

Tags with category FALSE_POSITIVE must not be mixed with tags from other categories (e.g. FRAUD, SCAM) — the intent cannot be reconciled and the request will be rejected with 422.

Tags with category IN_REVIEW follow the same mutual-exclusivity rule — IN_REVIEW tags do not trigger provider feedback and must not be combined with non-IN_REVIEW tags.

Minimum array length: 1
Example:
[
  "12345678-1234-1234-1234-123456789012",
  "87654321-4321-4321-4321-210987654321"
]
​
comment
object

Optional comment to be recorded in the audit log for this classification.

Response

Created — all activities tagged and provider feedback dispatched

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
mappings
object[]
required

Tag mappings applied to each classified activity, grouped by activity object.