{"items":[{"type":"link","label":"Rules","link":"/openapi/risk/rules.openapi","routeSlug":"/openapi/risk/rules.openapi","content":{"contentType":"overview","meta":{"name":"Rules"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"rules.openapi.json","url":"/_bundle/openapi/risk/rules.openapi.json?download"},{"kind":"download","label":"rules.openapi.yaml","url":"/_bundle/openapi/risk/rules.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":"Rules","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Rules APIs provided by Fraud Prevention are used to fine-tune Fraud Prevention decisions."}],"sectionId":"/openapi/risk/rules.openapi"}],"sectionId":"/openapi/risk/rules.openapi"}]}]}},{"label":"Create rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/rules.openapi/other/createrule","routeSlug":"/openapi/risk/rules.openapi/other/createrule","metadata":{"seo":{"title":"Create rule","description":"Creates a new recommendation rule. Returns the rule_id used to reference the rule in subsequent requests, along with the rule data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRule","name":"Create rule","isWebhook":false,"pointer":"/paths/~1rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new recommendation rule. Returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to reference the rule in subsequent requests, along with the rule data."},"children":[]}]}]}]},{"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/rule_request"}},"schemaId":"components/schemas/rule_request","pointer":"/paths/~1rules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rules","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/rule_request"}},"responseCodes":["201","400","401","403","409","429","500"],"pointer":"/rules","href":"other/createrule","openApiOperationId":"createRule","summary":"Create rule"},"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/rule_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rule_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Rules created and stored successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/create_rule_response"}},"schemaId":"components/schemas/create_rule_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"409","description":"Unique field collision"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/create_rule_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/create_rule_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/rules"},{"label":"Get all rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/rules.openapi/other/getrules","routeSlug":"/openapi/risk/rules.openapi/other/getrules","metadata":{"seo":{"title":"Get all rules","description":"Retrieves a list of all recommendation rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRules","name":"Get all rules","isWebhook":false,"pointer":"/paths/~1rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of all recommendation rules"},{"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":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules","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":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/rules","href":"other/getrules","openApiOperationId":"getRules","summary":"Get all rules"},"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rules retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get_all_response"}},"schemaId":"components/schemas/get_all_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/get_all_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get_all_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/rules"},{"label":"Get rule by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/rules.openapi/other/getrulebyid","routeSlug":"/openapi/risk/rules.openapi/other/getrulebyid","metadata":{"seo":{"title":"Get rule by ID","description":"Retrieves a specific recommendation rule by its ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRuleById","name":"Get rule by ID","isWebhook":false,"pointer":"/paths/~1rules~1{rule_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific recommendation rule by its ID"},{"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":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rule_id","in":"path","schemaId":"schema_304","description":"ID of the recommendation rule","required":true}],"pointer":"/paths/~1rules~1{rule_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/rules/{rule_id}","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":[{"name":"rule_id","in":"path","required":true,"schemaId":"schema_304"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/rules/{rule_id}","href":"other/getrulebyid","openApiOperationId":"getRuleById","summary":"Get rule by ID"},"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rule retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get_rule_response"}},"schemaId":"components/schemas/get_rule_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1rules~1{rule_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/get_rule_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get_rule_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/rules/{rule_id}"},{"label":"Update rule by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/rules.openapi/other/updaterule","routeSlug":"/openapi/risk/rules.openapi/other/updaterule","metadata":{"seo":{"title":"Update rule by ID","description":"Updates a specific recommendation rule"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRule","name":"Update rule by ID","isWebhook":false,"pointer":"/paths/~1rules~1{rule_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific recommendation rule"},{"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":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rule_id","in":"path","schemaId":"schema_304","description":"ID of the recommendation rule","required":true}],"pointer":"/paths/~1rules~1{rule_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rule_request"}},"schemaId":"components/schemas/rule_request","pointer":"/paths/~1rules~1{rule_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/rules/{rule_id}","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":[{"name":"rule_id","in":"path","required":true,"schemaId":"schema_304"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/rule_request"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/rules/{rule_id}","href":"other/updaterule","openApiOperationId":"updateRule","summary":"Update rule by ID"},"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/rule_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/rule_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rule updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/update_rule_response"}},"schemaId":"components/schemas/update_rule_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1rules~1{rule_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/update_rule_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/update_rule_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/rules/{rule_id}"},{"label":"Delete rule by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/rules.openapi/other/deleterule","routeSlug":"/openapi/risk/rules.openapi/other/deleterule","metadata":{"seo":{"title":"Delete rule by ID","description":"Deletes a specific recommendation rule. Note that you can also disable rules if needed using the enabled rule attribute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRule","name":"Delete rule by ID","isWebhook":false,"pointer":"/paths/~1rules~1{rule_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete rule by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific recommendation rule. Note that you can also disable rules if needed using the enabled rule attribute."},{"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":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rule_id","in":"path","schemaId":"schema_304","description":"ID of the recommendation rule","required":true}],"pointer":"/paths/~1rules~1{rule_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/rules/{rule_id}","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":[{"name":"rule_id","in":"path","required":true,"schemaId":"schema_304"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/rules/{rule_id}","href":"other/deleterule","openApiOperationId":"deleteRule","summary":"Delete rule by ID"},"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rule updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/delete_rule_response"}},"schemaId":"components/schemas/delete_rule_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1rules~1{rule_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/delete_rule_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/delete_rule_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/rules/{rule_id}"}],"store":{"schemaStore":{"components/schemas/rule_request":{"id":"components/schemas/rule_request","kind":"json-schema","title":"rule_request","data":{"type":"object","description":"Recommendation rule","required":["priority","recommendation","mode","type","matchers"],"properties":{"name":{"$ref":"#/components/schemas/rule_name"},"priority":{"$ref":"#/components/schemas/rule_priority"},"recommendation":{"$ref":"#/components/schemas/rule_recommendation_type"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"mode":{"$ref":"#/components/schemas/rule_mode"},"type":{"$ref":"#/components/schemas/rule_type"},"description":{"$ref":"#/components/schemas/rule_description"},"matchers":{"$ref":"#/components/schemas/matchers"}}}},"components/schemas/rule_response":{"id":"components/schemas/rule_response","kind":"json-schema","title":"rule_response","data":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/components/schemas/rule_id"}}},{"$ref":"#/components/schemas/rule_request"},{"$ref":"#/components/schemas/rules_dates"}]}},"components/schemas/rules_dates":{"id":"components/schemas/rules_dates","kind":"json-schema","title":"rules_dates","data":{"type":"object","properties":{"created_date":{"type":"string","description":"Date the rule was created","format":"date"},"updated_date":{"type":"string","description":"Date the rule was last updated","format":"date"}}}},"components/schemas/matchers":{"id":"components/schemas/matchers","kind":"json-schema","title":"matchers","data":{"type":"array","description":"Contains a set of activity matchers that define the rule matching logic","items":{"$ref":"#/components/schemas/matcher_info"}}},"components/schemas/matcher_info":{"id":"components/schemas/matcher_info","kind":"json-schema","title":"matcher_info","data":{"type":"object","description":"Contains a set of activity matchers that define the rule matching logic","properties":{"ip_cidrs":{"$ref":"#/components/schemas/ip_cidrs_matcher"},"device_ids":{"$ref":"#/components/schemas/device_ids_matcher"},"device_fingerprints":{"$ref":"#/components/schemas/device_fingerprints_matcher"},"device_public_keys":{"$ref":"#/components/schemas/device_public_keys_matcher"},"user_ids":{"$ref":"#/components/schemas/user_ids_matcher"},"country_codes":{"$ref":"#/components/schemas/country_codes_matcher"},"browser_names":{"$ref":"#/components/schemas/browser_names_matcher"},"os_versions":{"$ref":"#/components/schemas/os_versions_matcher"},"action_type":{"$ref":"#/components/schemas/action_type_matcher"},"client_id":{"$ref":"#/components/schemas/client_id_matcher"},"application_id":{"$ref":"#/components/schemas/application_id_matcher"},"asn_id":{"$ref":"#/components/schemas/asn_id_matcher"},"organization_name":{"$ref":"#/components/schemas/organization_name_matcher"},"organization_type":{"$ref":"#/components/schemas/organization_type_matcher"},"ip_timezone":{"$ref":"#/components/schemas/ip_timezone_matcher"},"device_timezone":{"$ref":"#/components/schemas/device_timezone_matcher"},"device_platform":{"$ref":"#/components/schemas/device_platform_matcher"},"user_agent":{"$ref":"#/components/schemas/user_agent_matcher"},"location":{"$ref":"#/components/schemas/location_matcher"}}}},"components/schemas/ip_cidrs_matcher":{"id":"components/schemas/ip_cidrs_matcher","kind":"json-schema","title":"ip_cidrs_matcher","data":{"type":"object","description":"Matches based on IP address","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["ip_in","ip_not_in"]},"value":{"type":"array","description":"List of IP ranges in CIDR notation","items":{"type":"string"}}}}},"components/schemas/device_ids_matcher":{"id":"components/schemas/device_ids_matcher","kind":"json-schema","title":"device_ids_matcher","data":{"type":"object","description":"Matches based on the device ID","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of device identifiers generated by Transmit Security and stored by the SDK","items":{"type":"string"}}}}},"components/schemas/device_fingerprints_matcher":{"id":"components/schemas/device_fingerprints_matcher","kind":"json-schema","title":"device_fingerprints_matcher","data":{"type":"object","description":"Matches based on device fingerprint","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of device fingerprints calculated based on multiple device persistent identifiers","items":{"type":"string"}}}}},"components/schemas/device_public_keys_matcher":{"id":"components/schemas/device_public_keys_matcher","kind":"json-schema","title":"device_public_keys_matcher","data":{"type":"object","description":"Matches based on device key ID","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of unique and persistent device key IDs derived from cryptographic binding","items":{"type":"string"}}}}},"components/schemas/user_ids_matcher":{"id":"components/schemas/user_ids_matcher","kind":"json-schema","title":"user_ids_matcher","data":{"type":"object","description":"Matches based on user identifier","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of opaque identifiers of users in your system","items":{"type":"string"}}}}},"components/schemas/country_codes_matcher":{"id":"components/schemas/country_codes_matcher","kind":"json-schema","title":"country_codes_matcher","data":{"type":"object","description":"Matches based on the country in which the device is located","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of country codes per ISO 3166-1 alpha-2 standard","items":{"type":"string"}}}}},"components/schemas/browser_names_matcher":{"id":"components/schemas/browser_names_matcher","kind":"json-schema","title":"browser_names_matcher","data":{"type":"object","description":"Matches based on browser name","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of browser names as presented by Transmit Security systems. e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yandex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"electron"},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/os_versions_matcher":{"id":"components/schemas/os_versions_matcher","kind":"json-schema","title":"os_versions_matcher","data":{"type":"object","description":"Matches based on the device OS version","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of OS versions as presented by Transmit Security systems. e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14.4.2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x86_64"},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/action_type_matcher":{"id":"components/schemas/action_type_matcher","kind":"json-schema","title":"action_type_matcher","data":{"type":"object","description":"Matches based on the client action for which the recommendation is requested","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of client actions (such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"login"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"register"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"guides/risk/recommendations/#action-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]}]}]}],"items":{"type":"string"}}}}},"components/schemas/client_id_matcher":{"id":"components/schemas/client_id_matcher","kind":"json-schema","title":"client_id_matcher","data":{"type":"object","description":"Matches based on client ID","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of client IDs","items":{"type":"string"}}}}},"components/schemas/application_id_matcher":{"id":"components/schemas/application_id_matcher","kind":"json-schema","title":"application_id_matcher","data":{"type":"object","description":"Matches based on app ID","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of application IDs, used to identify Transmit applications","items":{"type":"string"}}}}},"components/schemas/asn_id_matcher":{"id":"components/schemas/asn_id_matcher","kind":"json-schema","title":"asn_id_matcher","data":{"type":"object","description":"Matches based on the ASN detected using the IP address","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of AS numbers detected by Transmit using IP address (e.g., AS13339)","items":{"type":"string"}}}}},"components/schemas/organization_name_matcher":{"id":"components/schemas/organization_name_matcher","kind":"json-schema","title":"organization_name_matcher","data":{"type":"object","description":"Matches based on the organization name associated with the IP address","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of organization names","items":{"type":"string"}}}}},"components/schemas/organization_type_matcher":{"id":"components/schemas/organization_type_matcher","kind":"json-schema","title":"organization_type_matcher","data":{"type":"object","description":"Matches based on the organization type associated with the IP address","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of organization types","items":{"type":"string"}}}}},"components/schemas/ip_timezone_matcher":{"id":"components/schemas/ip_timezone_matcher","kind":"json-schema","title":"ip_timezone_matcher","data":{"type":"object","description":"Matches based on the timezone detected by Transmit using IP address","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of TZ identifiers (e.g., America/New_York, Asia/Tokyo, UTC)"},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/device_timezone_matcher":{"id":"components/schemas/device_timezone_matcher","kind":"json-schema","title":"device_timezone_matcher","data":{"type":"object","description":"Matches based on the timezone detected by Transmit using device telemetry","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of TZ identifiers (e.g., America/New_York , Asia/Tokyo, UTC)"},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/device_platform_matcher":{"id":"components/schemas/device_platform_matcher","kind":"json-schema","title":"device_platform_matcher","data":{"type":"object","description":"Matches based on device type, as classified by Transmit (e.g., desktop, mobile, wearable)","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["in","not_in"]},"value":{"type":"array","description":"List of device types, as classified by Transmit (e.g., desktop , mobile, wearable)","items":{"type":"string"}}}}},"components/schemas/user_agent_matcher":{"id":"components/schemas/user_agent_matcher","kind":"json-schema","title":"user_agent_matcher","data":{"type":"object","description":"Matches based on user agent","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["contains","not_contains"]},"value":{"type":"array","description":"List of user agents","items":{"type":"string"}}}}},"components/schemas/location_matcher":{"id":"components/schemas/location_matcher","kind":"json-schema","title":"location_matcher","data":{"type":"object","description":"Matches based on the place in the application in which the action was performed (such as page URL)","required":["op","value"],"properties":{"op":{"type":"string","description":"Matcher operation","enum":["contains","not_contains"]},"value":{"type":"array","description":"List of locations (e.g., page URLs)","items":{"type":"string"}}}}},"components/schemas/rule_recommendation_type":{"id":"components/schemas/rule_recommendation_type","kind":"json-schema","title":"rule_recommendation_type","data":{"type":"string","description":"Recommendation type","enum":["challenge","deny","trust","allow"]}},"components/schemas/rule_name":{"id":"components/schemas/rule_name","kind":"json-schema","title":"rule_name","data":{"type":"string","example":"Block risky countries","description":"Name of the recommendation rule. Must be unique across the tenant. Autogenerated if not provided.\n"}},"components/schemas/rule_priority":{"id":"components/schemas/rule_priority","kind":"json-schema","title":"rule_priority","data":{"type":"integer","example":10,"minimum":1,"maximum":1000,"description":"Priority of the recommendation rule, which determines the order in which rules are evaluated. Rules are evaluated from smallest to biggest priority value and only the first rule to match will apply. Priority value must be unique.\n"}},"components/schemas/rule_enabled":{"id":"components/schemas/rule_enabled","kind":"json-schema","title":"rule_enabled","data":{"type":"boolean","default":false,"description":"Whether or not the rule will be evaluated."}},"components/schemas/rule_mode":{"id":"components/schemas/rule_mode","kind":"json-schema","title":"rule_mode","data":{"type":"string","description":"Allows you to simulate a rule and evaluate its impact before releasing it to production. The simulation occurs each time a recommendation is requested. If a preview rule matches the request (meaning, its priority is higher than all matching rules), the response will include this preview rule and what the recommendation would have been if all rules were in production.\n","enum":["preview","production"]}},"components/schemas/rule_type":{"id":"components/schemas/rule_type","kind":"json-schema","title":"rule_type","data":{"type":"string","description":"Default type, must be \"risk\"","enum":["risk"]}},"components/schemas/rule_description":{"id":"components/schemas/rule_description","kind":"json-schema","title":"rule_description","data":{"type":"string","description":"Description for the rule"}},"components/schemas/rule_id":{"id":"components/schemas/rule_id","kind":"json-schema","title":"rule_id","data":{"type":"string","description":"ID of the recommendation rule, used to reference the rule","format":"uuid"}},"components/schemas/create_rule_response":{"id":"components/schemas/create_rule_response","kind":"json-schema","title":"create_rule_response","data":{"type":"object","properties":{"message":{"type":"string"},"rule_id":{"$ref":"#/components/schemas/rule_id"},"data":{"$ref":"#/components/schemas/rule_response"}}}},"components/schemas/get_all_response":{"id":"components/schemas/get_all_response","kind":"json-schema","title":"get_all_response","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/rule_response"}}}}},"components/schemas/get_rule_response":{"id":"components/schemas/get_rule_response","kind":"json-schema","title":"get_rule_response","data":{"type":"object","properties":{"id":{"type":"string","description":"Rule ID"},"data":{"$ref":"#/components/schemas/rule_response"}}}},"components/schemas/update_rule_response":{"id":"components/schemas/update_rule_response","kind":"json-schema","title":"update_rule_response","data":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/rule_response"}}}},"components/schemas/delete_rule_response":{"id":"components/schemas/delete_rule_response","kind":"json-schema","title":"delete_rule_response","data":{"type":"object","properties":{"message":{"type":"string"}}}},"schema_304":{"kind":"json-schema","data":{"type":"string"},"id":"schema_304"}},"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/rules.openapi.json?download"},{"url":"/_bundle/openapi/risk/rules.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Rules","description":"Rules APIs provided by Fraud Prevention are used to fine-tune Fraud Prevention decisions."}},"baseSlug":"/openapi/risk/rules.openapi","routesMapping":{}}