Skip to content

Labels

Labels API provided by Fraud Prevention allows you to give feedback about the accuracy of recommendations you received from Transmit Security.

Download OpenAPI description
label.openapi.json
label.openapi.yaml
Languages
Servers
Sandbox environment
https://api.sbx.transmitsecurity.io/risk/v1/
Production environment (US)
https://api.transmitsecurity.io/risk/v1/
Production environment (EU)
https://api.eu.transmitsecurity.io/risk/v1/
Production environment (CA)
https://api.ca.transmitsecurity.io/risk/v1/
Production environment (AU)
https://api.au.transmitsecurity.io/risk/v1/

Send label

Request

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

Security
risk_access_token
Bodyapplication/jsonrequired
label_typestringrequired

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

Subject of the label

subject.​typestringrequired

The subject type.

Enum"ACTION_ID""CORRELATION_ID""CAMPAIGN_ID""USER_ID""IP_ADDRESS""VERIFICATION_SESSION_ID""FRAUD_RING_ID"
subject.​valuestringrequired

The subject value

Example: "a05f8ae1-718f-4c33-a20c-682df281af7c"
subject.​recommendationsArray of strings or null

For FRAUD_RING_ID labels only. Allows labeling actions with specific recommendation.

Enum"allow""trust""challenge""deny"
subject.​is_campaign_confirmedboolean or null

For CAMPAIGN_ID labels only. Defines whether or not to label actions related to the campaign.

use_casestring

The fraud scenario.

Enum"ACCOUNT_TAKEOVER""FIRST_PARTY_FRAUD""IDENTITY_THEFT""MONEY_MULE""BOT_ATTACK""SYNTHETIC_IDENTITY""SOCIAL_ENGINEERING"
sourcestring

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

Enum ValueDescription
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

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/risk/v1/label \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label_type": "KNOWN_MALICIOUS",
    "subject": {
      "type": "ACTION_ID",
      "value": "a05f8ae1-718f-4c33-a20c-682df281af7c",
      "recommendations": [
        "allow"
      ],
      "is_campaign_confirmed": true
    },
    "use_case": "ACCOUNT_TAKEOVER",
    "source": "MANUAL_REVIEW"
  }'

Responses

Label has been received and stored successfully.

Bodyapplication/json
messagestringrequired
label_idstringrequired

ID of the saved label

labelobjectrequired
label.​label_idstring

ID of the saved label

label.​label_typestringrequired

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"
label.​subjectobjectrequired

Subject of the label

label.​subject.​typestringrequired

The subject type.

Enum"ACTION_ID""CORRELATION_ID""CAMPAIGN_ID""USER_ID""IP_ADDRESS""VERIFICATION_SESSION_ID""FRAUD_RING_ID"
label.​subject.​valuestringrequired

The subject value

Example: "a05f8ae1-718f-4c33-a20c-682df281af7c"
label.​subject.​recommendationsArray of strings or null

For FRAUD_RING_ID labels only. Allows labeling actions with specific recommendation.

Enum"allow""trust""challenge""deny"
label.​subject.​is_campaign_confirmedboolean or null

For CAMPAIGN_ID labels only. Defines whether or not to label actions related to the campaign.

label.​use_casestring

The fraud scenario.

Enum"ACCOUNT_TAKEOVER""FIRST_PARTY_FRAUD""IDENTITY_THEFT""MONEY_MULE""BOT_ATTACK""SYNTHETIC_IDENTITY""SOCIAL_ENGINEERING"
label.​sourcestring

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

Enum ValueDescription
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

label.​label_timestampnumber

Unix time indicating the label creation time

Example: 1725961384920
afftectedActionIdsArray of stringsrequired
Example: ["af819f2b3e2f1b2820077cb09fe92de5769c4e4b24030cf683f4d0b155ac4999","9b83568185c39e4acb3e5d09176f0a70efdf5c414c2d1d90cb803dfb0b93ec53"]
Response
application/json
{
  "message": "string",
  "label_id": "string",
  "label": {
    "label_id": "string",
    "label_type": "KNOWN_MALICIOUS",
    "subject": { … },
    "use_case": "ACCOUNT_TAKEOVER",
    "source": "MANUAL_REVIEW",
    "label_timestamp": 1725961384920
  },
  "afftectedActionIds": [
    "af819f2b3e2f1b2820077cb09fe92de5769c4e4b24030cf683f4d0b155ac4999",
    "9b83568185c39e4acb3e5d09176f0a70efdf5c414c2d1d90cb803dfb0b93ec53"
  ]
}