Labels

Download OpenAPI specification:Download

Labels API provided by Detection and Response services allows you to give feedback about the accuracy of recommendations you received from Transmit Security.

Send label

Sends the label to our servers for analysis to improve our recommendation system.

SecurityHTTP: risk_access_token
Request
Request Body schema: application/json
required
label_type
required
string

Type of label to send, which contains additional information that helps to classify the subject as fraudulent or legitimate

Enum: "KNOWN_MALICIOUS" "SUSPECTED_MALICIOUS" "KNOWN_LEGIT" "UNKNOWN"
required
object (subject)

Subject of the label

use_case
string

The fraud scenario.

Enum: "ACCOUNT_TAKEOVER" "FIRST_PARTY_FRAUD" "IDENTITY_THEFT" "MONEY_MULE" "BOT_ATTACK" "SYNTHETIC_IDENTITY" "SOCIAL_ENGINEERING"
source
string

Source of the label information, such as a customer complaint about friction or additional information from another risk or fraud system.

Enum: Description
MANUAL_REVIEW

from self manual analysis

CUSTOMER_COMPLAINTS

from customer complains or responses

CHARGEBACKS

from incorrect charges

OTHER_VENDORS

from information and conclusion done in other systems and tools

Responses
201

Label has been received and stored successfully.

400

Bad request

401

Invalid authentication

403

Invalid authorization

429

Rate limit reached

500

Internal error

post/label
Request samples
application/json
{
  • "label_type": "KNOWN_MALICIOUS",
  • "subject": {
    },
  • "use_case": "ACCOUNT_TAKEOVER",
  • "source": "MANUAL_REVIEW"
}
Response samples
application/json
{
  • "message": "string",
  • "label_id": "string",
  • "label": {
    },
  • "afftectedActionIds": [
    ]
}