Sign in

v1

latestOpenAPI 3.0.22026-08-061311.6 KB

Send label

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

post/label

Request body

label_type'CONFIRMED_FRAUD' | 'SUSPECTED_FRAUD' | 'CONFIRMED_LEGIT' | 'UNDETERMINED' required

Type of label to send, which contains additional information that helps to classify the subject as fraudulent or legitimate. The API accepts both the enum values below and the legacy values (KNOWN_MALICIOUS, SUSPECTED_MALICIOUS, KNOWN_LEGIT, UNKNOWN) for backward compatibility.

use_case'ACCOUNT_TAKEOVER' | 'DEVICE_TAKEOVER' | 'FIRST_PARTY_FRAUD' | 'IDENTITY_THEFT' | 'MONEY_MULE' | 'BOT_ATTACK' | 'SYNTHETIC_IDENTITY' | 'SOCIAL_ENGINEERING' | 'NEW_ACCOUNT_FRAUD' | 'CREDENTIAL_STUFFING'

Fraud scenario associated with the label. You can further classify the scenario by providing sub_category and, for supported scenarios, attack_method. For supported values and combinations, see Specify fraud scenarios with labels.

sub_category'PHISHING' | 'MALWARE' | 'CREDENTIAL_BREACH' | 'DEVICE_TAKEOVER' | 'SESSION_HIJACKING' | 'RECOVERY_ABUSE' | 'INVESTMENT_SCAM' | 'ROMANCE_SCAM' | 'TECH_SUPPORT_SCAM' | 'PAYMENT_SCAM' | 'IMPERSONATION_SCAM' | 'COERCION' | 'DATA_BREACH' | 'PHYSICAL_THEFT' | 'SOCIAL_ENGINEERING' | 'CHARGEBACK_FRIENDLY_FRAUD' | 'BUST_OUT_FRAUD' | 'ACCOUNT_AGING' | 'APPLICATION_KYC_FRAUD' | 'REFERRAL_ABUSE' | 'SIGNUP_BONUS_ABUSE' | 'REWARDS_MANIPULATION' | 'STOLEN_IDENTITY' | 'SYNTHETIC_IDENTITY' | 'MULE_ACCOUNT' | 'BONUS_PROMO_ABUSE' | 'OTHER'

Optional refinement of use_case. Valid values depend on the selected use_case. Do not provide this field for MONEY_MULE or CREDENTIAL_STUFFING. For supported values by use case, see Specify fraud scenarios with labels.

attack_method'PHISHING_EMAIL' | 'PHISHING_SMS' | 'PHISHING_VOICE' | 'PHISHING_QR' | 'KEYLOGGER' | 'TROJAN' | 'SPYWARE' | 'BROWSER_MALWARE' | 'COMBO_LIST' | 'PASSWORD_SPRAYING' | 'AUTOMATED_TESTING' | 'REMOTE_DESKTOP' | 'SCREEN_SHARING' | 'REMOTE_SHELL' | 'ROOTKIT' | 'MITM' | 'TOKEN_THEFT_XSS' | 'TOKEN_THEFT_MALWARE' | 'SESSION_FIXATION' | 'PHISHING_RECOVERY' | 'HELPDESK_SOCENG' | 'FLOW_EXPLOITATION' | 'PHONE' | 'SOCIAL_MEDIA' | 'FAKE_PLATFORM' | 'DATING_APP' | 'MESSAGING_APP' | 'FAKE_POPUP' | 'COLD_CALL' | 'EMAIL' | 'FAKE_INVOICE' | 'IMPERSONATION' | 'URGENT_TRANSFER' | 'BANK' | 'GOVERNMENT' | 'FAMILY_EMERGENCY' | 'INPERSON' | 'LIVE_PHONE' | 'DATA_BREACH' | 'PHYSICAL_THEFT' | 'SOCIAL_ENGINEERING' | 'PHISHING' | 'PHYSICAL_DOC_THEFT' | 'DOCUMENT_FABRICATION' | 'DATA_COMBINATION' | 'AI_GENERATED' | 'JOB_SCAM_RECRUITMENT' | 'ROMANCE_RECRUITMENT' | 'NETWORK_RECRUITMENT' | 'MULTI_ACCOUNT' | 'BOT_AUTOMATION' | 'JOB_SCAM' | 'ROMANCE_SCAM' | 'INVESTMENT_SCAM' | 'SELF_RECRUITED' | 'COERCED' | 'UNKNOWN' | 'OTHER'

Optional attack method associated with the label. Valid values depend on the selected sub_category, or directly on use_case for MONEY_MULE and CREDENTIAL_STUFFING. Do not provide this field for FIRST_PARTY_FRAUD. For supported values and combinations, see Specify fraud scenarios with labels.

source'MANUAL_REVIEW' | 'CUSTOMER_COMPLAINTS' | 'CHARGEBACKS' | 'OTHER_VENDORS' | 'AUTOMATED_DETECTION' | 'LAW_ENFORCEMENT'

Source of the information used to assign the label, such as manual review, customer complaints, chargebacks, another fraud system, automated detection, or law enforcement. For supported values and definitions, see Specify fraud scenarios with labels.

Example request

{
  "subject": {
    "value": "a05f8ae1-718f-4c33-a20c-682df281af7c"
  }
}

Response

Label has been received and stored successfully.

messagestring required
label_idstring required

ID of the saved label

afftectedActionIdsstring[] required

Example response

{
  "label": {
    "subject": {
      "value": "a05f8ae1-718f-4c33-a20c-682df281af7c"
    },
    "label_timestamp": 1725961384920
  },
  "afftectedActionIds": [
    "af819f2b3e2f1b2820077cb09fe92de5769c4e4b24030cf683f4d0b155ac4999",
    "9b83568185c39e4acb3e5d09176f0a70efdf5c414c2d1d90cb803dfb0b93ec53"
  ]
}