{"items":[{"type":"link","label":"Labels","link":"/openapi/risk/label.openapi","routeSlug":"/openapi/risk/label.openapi","content":{"contentType":"overview","meta":{"name":"Labels"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"label.openapi.json","url":"/_bundle/openapi/risk/label.openapi.json?download"},{"kind":"download","label":"label.openapi.yaml","url":"/_bundle/openapi/risk/label.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Labels","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Labels API provided by Fraud Prevention allows you to give feedback about the accuracy of recommendations you received from Transmit Security."}],"sectionId":"/openapi/risk/label.openapi"}],"sectionId":"/openapi/risk/label.openapi"}]}]}},{"label":"Send label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/label.openapi/other/sendlabel","routeSlug":"/openapi/risk/label.openapi/other/sendlabel","metadata":{"seo":{"title":"Send label","description":"Sends the label to our servers for analysis to improve our recommendation system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendLabel","name":"Send label","isWebhook":false,"pointer":"/paths/~1label/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends the label to our servers for analysis to improve our recommendation system."},{"nodeType":"security","requirements":[{"schemes":[{"name":"risk_access_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token generated by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/label"}},"schemaId":"components/schemas/label","pointer":"/paths/~1label/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/label","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/label"}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/label","href":"other/sendlabel","openApiOperationId":"sendLabel","summary":"Send label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"schemaId":"components/schemas/label","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/label"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Label has been received and stored successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label_success_response"}},"schemaId":"components/schemas/label_success_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1label/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/label_success_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label_success_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/label"}],"store":{"schemaStore":{"components/schemas/label":{"id":"components/schemas/label","kind":"json-schema","title":"label","data":{"type":"object","required":["label_type","subject"],"properties":{"label_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KNOWN_MALICIOUS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPECTED_MALICIOUS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KNOWN_LEGIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for backward compatibility."},"children":[]}]}]}],"enum":["CONFIRMED_FRAUD","SUSPECTED_FRAUD","CONFIRMED_LEGIT","UNDETERMINED"]},"subject":{"$ref":"#/components/schemas/subject"},"use_case":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fraud scenario associated with the label. You can further classify the scenario by providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and, for supported scenarios, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attack_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported values and combinations, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/risk/label-fraud-scenarios"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify fraud scenarios with labels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ACCOUNT_TAKEOVER","DEVICE_TAKEOVER","FIRST_PARTY_FRAUD","IDENTITY_THEFT","MONEY_MULE","BOT_ATTACK","SYNTHETIC_IDENTITY","SOCIAL_ENGINEERING","NEW_ACCOUNT_FRAUD","CREDENTIAL_STUFFING"]},"sub_category":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional refinement of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"use_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Valid values depend on the selected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"use_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not provide this field for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONEY_MULE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDENTIAL_STUFFING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported values by use case, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/risk/label-fraud-scenarios"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify fraud scenarios with labels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["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"]},"attack_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional attack method associated with the label. Valid values depend on the selected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or directly on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"use_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONEY_MULE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDENTIAL_STUFFING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not provide this field for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIRST_PARTY_FRAUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported values and combinations, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/risk/label-fraud-scenarios"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify fraud scenarios with labels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["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"]},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/risk/label-fraud-scenarios"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify fraud scenarios with labels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["MANUAL_REVIEW","CUSTOMER_COMPLAINTS","CHARGEBACKS","OTHER_VENDORS","AUTOMATED_DETECTION","LAW_ENFORCEMENT"]}}}},"components/schemas/subject":{"id":"components/schemas/subject","kind":"json-schema","title":"subject","data":{"description":"Subject of the label","properties":{"type":{"type":"string","description":"The subject type.","enum":["ACTION_ID","CORRELATION_ID","CAMPAIGN_ID","USER_ID","IP_ADDRESS","VERIFICATION_SESSION_ID","FRAUD_RING_ID"]},"value":{"type":"string","description":"The subject value","example":"a05f8ae1-718f-4c33-a20c-682df281af7c"},"recommendations":{"type":"array","items":{"type":"string","description":"ID of the list item.","enum":["allow","trust","challenge","deny"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRAUD_RING_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" labels only. Allows labeling actions with specific recommendation."},"children":[]}]}]}],"nullable":true},"is_campaign_confirmed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAMPAIGN_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" labels only. Defines whether or not to label actions related to the campaign."},"children":[]}]}]}],"nullable":true}},"required":["type","value"]}},"components/schemas/label_success_response":{"id":"components/schemas/label_success_response","kind":"json-schema","title":"label_success_response","data":{"type":"object","properties":{"message":{"type":"string"},"label_id":{"type":"string","description":"ID of the saved label"},"label":{"allOf":[{"type":"object","properties":{"label_id":{"type":"string","description":"ID of the saved label"}}},{"$ref":"#/components/schemas/label"},{"type":"object","properties":{"label_timestamp":{"type":"number","description":"Unix time indicating the label creation time","example":1725961384920}}}]},"afftectedActionIds":{"type":"array","items":{"type":"string","description":"All action IDs which were labeled with current label request."},"example":["af819f2b3e2f1b2820077cb09fe92de5769c4e4b24030cf683f4d0b155ac4999","9b83568185c39e4acb3e5d09176f0a70efdf5c414c2d1d90cb803dfb0b93ec53"]}},"required":["message","label_id","label","afftectedActionIds"]}}},"exampleStore":{},"securitySchemeStore":{"risk_access_token":{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token generated by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]}]}]}]}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/risk/label.openapi.json?download"},{"url":"/_bundle/openapi/risk/label.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Labels","description":"Labels API provided by Fraud Prevention allows you to give feedback about the accuracy of recommendations you received from Transmit Security."}},"baseSlug":"/openapi/risk/label.openapi","routesMapping":{}}