{"items":[{"type":"link","label":"Client Actions","link":"/openapi/risk/client-actions.openapi","routeSlug":"/openapi/risk/client-actions.openapi","content":{"contentType":"overview","meta":{"name":"Client Actions"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"client-actions.openapi.json","url":"/_bundle/openapi/risk/client-actions.openapi.json?download"},{"kind":"download","label":"client-actions.openapi.yaml","url":"/_bundle/openapi/risk/client-actions.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":"Client Actions","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This backend API is used to report client actions, add the user context and report action results, allowing Fraud Prevention reporting and user profiling."}],"sectionId":"/openapi/risk/client-actions.openapi"}],"sectionId":"/openapi/risk/client-actions.openapi"}]}]}},{"label":"Trigger action event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/client-actions.openapi/other/triggeranaction","routeSlug":"/openapi/risk/client-actions.openapi/other/triggeranaction","metadata":{"seo":{"title":"Trigger action event","description":"Report a client action event that occurs in an SDK session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerAnAction","name":"Trigger action event","isWebhook":false,"pointer":"/paths/~1action~1trigger-action/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger action event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report a client action event that occurs in an SDK session."},{"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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"get_recommendation","in":"query","schemaId":"schema_294","description":"A flag for getting the recommendation for the triggered action (for saving another recommendation backend call)"}],"pointer":"/paths/~1action~1trigger-action/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/triggeraction"}},"schemaId":"components/schemas/triggeraction","pointer":"/paths/~1action~1trigger-action/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/action/trigger-action","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":[{"name":"get_recommendation","in":"query","required":false,"schemaId":"schema_294"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/triggeraction"}},"responseCodes":["201","400","401","403","429","463","500"],"pointer":"/action/trigger-action","href":"other/triggeranaction","openApiOperationId":"triggerAnAction","summary":"Trigger action event"},"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/triggeraction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/triggeraction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Trigger action has been received and stored successfully. The response also contains a recommendation, if requested.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295"}},"schemaId":"schema_295"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization"},{"code":"429","description":"Rate limit reached"},{"code":"463","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklisted token—Returned when Fraud Prevention detects repeated or abusive token/payload misuse within a short time window (e.g., reuse of expired tokens, token caching/automation, or repeated invalid requests, including highly repetitive invalid request values). The response body contains the underlying error code (e.g., expired session token). Clients should identify and stop the source of invalid requests. Other authorization failures that do not trigger blacklisting return 403 Forbidden."},"children":[]}]}]}]},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1action~1trigger-action/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"463"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/action/trigger-action"},{"label":"Report action result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/client-actions.openapi/other/reportactionresult","routeSlug":"/openapi/risk/client-actions.openapi/other/reportactionresult","metadata":{"seo":{"title":"Report action result","description":"Reports the result of an action that a recommendation was issued for. This includes whether the user successfully completed the action, and what type of challenge was given to the user (if any)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reportActionResult","name":"Report action result","isWebhook":false,"pointer":"/paths/~1action~1result/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report action result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reports the result of an action that a recommendation was issued for. This includes whether the user successfully completed the action, and what type of challenge was given to the user (if any)."},{"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/actionResult"}},"schemaId":"components/schemas/actionResult","pointer":"/paths/~1action~1result/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/action/result","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/actionResult"}},"responseCodes":["201","400","401","403","429","463","500"],"pointer":"/action/result","href":"other/reportactionresult","openApiOperationId":"reportActionResult","summary":"Report action result"},"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/actionResult","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/actionResult"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Action result has been received and stored successfully."},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization"},{"code":"429","description":"Rate limit reached"},{"code":"463","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklisted token—Returned when Fraud Prevention detects repeated or abusive token/payload misuse within a short time window (e.g., reuse of expired tokens, token caching/automation, or repeated invalid requests, including highly repetitive invalid request values). The response body contains the underlying error code (e.g., expired session token). Clients should identify and stop the source of invalid requests. Other authorization failures that do not trigger blacklisting return 403 Forbidden."},"children":[]}]}]}]},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1action~1result/post/responses"}],"panels":[]}]},"httpPath":"/action/result"},{"label":"Clear user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/client-actions.openapi/other/clearuser","routeSlug":"/openapi/risk/client-actions.openapi/other/clearuser","metadata":{"seo":{"title":"Clear user","description":"Clears the user context for all subsequent events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"clearUser","name":"Clear user","isWebhook":false,"pointer":"/paths/~1action~1clear-user/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clear user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Clears the user context for all subsequent events."},{"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/clearUser"}},"schemaId":"components/schemas/clearUser","pointer":"/paths/~1action~1clear-user/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/action/clear-user","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/clearUser"}},"responseCodes":["201","400","401","403","429","463","500"],"pointer":"/action/clear-user","href":"other/clearuser","openApiOperationId":"clearUser","summary":"Clear user"},"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/clearUser","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/clearUser"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The user association has been cleared for the device.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}},"schemaId":"schema_296"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization"},{"code":"429","description":"Rate limit reached"},{"code":"463","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklisted token—Returned when Fraud Prevention detects repeated or abusive token/payload misuse within a short time window (e.g., reuse of expired tokens, token caching/automation, or repeated invalid requests, including highly repetitive invalid request values). The response body contains the underlying error code (e.g., expired session token). Clients should identify and stop the source of invalid requests. Other authorization failures that do not trigger blacklisting return 403 Forbidden."},"children":[]}]}]}]},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1action~1clear-user/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"463"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/action/clear-user"},{"label":"Assign actions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/client-actions.openapi/other/updateactionassignee","routeSlug":"/openapi/risk/client-actions.openapi/other/updateactionassignee","metadata":{"seo":{"title":"Assign actions","description":"Set assignee for a list of actions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActionAssignee","name":"Assign actions","isWebhook":false,"pointer":"/paths/~1action~1assignee/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign actions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set assignee for a list of actions."},{"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/setAssignee"}},"schemaId":"components/schemas/setAssignee","pointer":"/paths/~1action~1assignee/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/action/assignee","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/setAssignee"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/action/assignee","href":"other/updateactionassignee","openApiOperationId":"updateActionAssignee","summary":"Assign actions"},"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/setAssignee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/setAssignee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assignee was updated for all requested actions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297"}},"schemaId":"schema_297"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1action~1assignee/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_297","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/action/assignee"},{"label":"Set authenticated user","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/client-actions.openapi/other/setauthuser","routeSlug":"/openapi/risk/client-actions.openapi/other/setauthuser","metadata":{"seo":{"title":"Set authenticated user","description":"Sets the user context for a client action reported to the SDK. It should be set only after you've fully authenticated the user (including, for example, any 2FA that was required). This call is deprecated, set the user with Report action result API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAuthUser","name":"Set authenticated user","deprecated":true,"isWebhook":false,"pointer":"/paths/~1action~1authenticated-user/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set authenticated user","isWebhook":false,"deprecated":true,"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":"Sets the user context for a client action reported to the SDK. It should be set only after you've fully authenticated the user (including, for example, any 2FA that was required). This call is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the user with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/risk/client-actions.openapi/other/reportactionresult"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report action result API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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/authuser"}},"schemaId":"components/schemas/authuser","pointer":"/paths/~1action~1authenticated-user/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/action/authenticated-user","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/authuser"}},"responseCodes":["201","400","401","403","429","463","500"],"pointer":"/action/authenticated-user","href":"other/setauthuser","openApiOperationId":"setAuthUser","summary":"Set authenticated user"},"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/authuser","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/authuser"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"User Auth has been received and stored successfully."},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization"},{"code":"429","description":"Rate limit reached"},{"code":"463","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklisted token—Returned when Fraud Prevention detects repeated or abusive token/payload misuse within a short time window (e.g., reuse of expired tokens, token caching/automation, or repeated invalid requests, including highly repetitive invalid request values). The response body contains the underlying error code (e.g., expired session token). Clients should identify and stop the source of invalid requests. Other authorization failures that do not trigger blacklisting return 403 Forbidden."},"children":[]}]}]}]},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1action~1authenticated-user/post/responses"}],"panels":[]}]},"httpPath":"/action/authenticated-user"}],"store":{"schemaStore":{"components/schemas/triggeraction":{"id":"components/schemas/triggeraction","kind":"json-schema","title":"triggeraction","data":{"oneOf":[{"$ref":"#/components/schemas/triggerActionWithSessionToken"},{"$ref":"#/components/schemas/triggerActionWithSecureSessionToken"}]}},"components/schemas/triggerActionBase":{"id":"components/schemas/triggerActionBase","kind":"json-schema","title":"triggerActionBase","data":{"type":"object","required":["action_type"],"properties":{"action_type":{"type":"string","description":"The action type","example":"transaction"},"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*Deprecated – Opaque identifier of the authenticated user in your system. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"claimed_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user isn't authenticated yet, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_context.user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user was already authenticated outside the current Fraud Prevention flow."},"children":[]}]}]}],"deprecated":true},"claimed_user_id_type":{"type":"string","enum":["email","phone_number","account_id","ssn","national_id","passport_number","drivers_license_number","other"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of value provided in the claimed_user_id field. This field is especially important when claimed_user_id contains a hashed value, as it clarifies the original data type used."},"children":[]}]}]}]},"claimed_user_id":{"type":"string","description":"User identifier of the not yet authenticated user, used to enhance risk and trust assessments. This field should not contain sensitive data in plain text. Once the user has authenticated, to set the user, report the action result via API call or call 'setAuthenticatedUser' from the client SDK. Rejected (400) if provided as \"null\", \"undefined\", \"none\", or empty/whitespace-only; leading/trailing whitespace is otherwise trimmed."},"auth_context":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds authentication context for users who were already authenticated "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outside the current Fraud Prevention flow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before this action was triggered (for example, on another site or through an external identity provider). Providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets the user for this action and uses the same user for all subsequent events in the device session, just as reporting a successful login with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/risk/client-actions.openapi/other/reportactionresult"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report action result"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_context.user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes precedence over both the user already associated with the device session and the deprecated top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An empty object ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is treated as if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not provided."},"children":[]}]}]}],"required":["user_id"],"properties":{"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque identifier of the authenticated user in your system. Required whenever "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_context"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, because its presence indicates that the user was already authenticated outside the current Fraud Prevention flow. Before validation, leading and trailing whitespace is trimmed. The value is rejected (400) if it is \"null\", \"undefined\", \"none\", empty, contains only whitespace, or doesn't match the user ID format configured for your tenant."},"children":[]}]}]}],"example":"user_8a72c1f0"},"login_timestamp":{"type":"number","description":"Unix timestamp (in milliseconds) of when the login happened","example":1767225600000},"challenge_type":{"type":"string","enum":["sms_otp","email_otp","totp","push_otp","voice_otp","idv","captcha","invisible_captcha","password","passkey","document_verification","security_question","knowledge_based_authentication","device_approval","out_of_band","otp","device_biometrics","face_id","fingerprint","mobile_approve","pin","cap_rep_token","symantec_token","duo","secure_id","csm","biometric","devicetag_rep_token","email_verification","magic_link","symantec_pin","web_to_mobile"],"description":"The challenge type used for the authentication action"},"failed_attempts":{"type":"integer","minimum":0,"description":"The number of failed attempts for the authentication action","example":1},"auth_method":{"type":"string","enum":["password","webauthn","totp","email_otp","sms_otp","direct_otp","voice_otp","push_otp","idv","email_magic_link","mobile_biometric","face","pin_authenticator","google","facebook","apple","line","saml","oidc"],"description":"The authentication method used for the authentication action"},"login_origin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origin the user logged in from. For web, the URL of the login page (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://example.com/login"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For mobile, the app bundle or package identifier (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"com.example.myapp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"https://example.com/login"}}},"correlation_id":{"type":"string","description":"Any ID that could help relate the action with external context or session"},"transaction_data":{"type":"object","description":"Transaction data-points given in the relevant action","properties":{"type":{"type":"string","description":"Type of transaction","enum":["purchase","bill_payment","mobile_recharge","money_transfer","credit_transfer","credit_redemption","top_up","withdrawal","investment","loan","refund","other"],"example":"purchase"},"method":{"type":"string","description":"Method used for the transaction","enum":["bank_account","wire","card","p2p","wallet"],"example":"card"},"reason":{"type":"string","description":"The reason for the transaction","example":"Monthly subscription payment","minLength":1,"maxLength":200},"amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The monetary amount of the transaction. The backend sanitizes this value with parseFloat; it must be strictly positive and ≤ 999,999,999.99"},"children":[]}]}]}],"example":1500.75},"currency":{"type":"string","description":"The transaction currency (ISO-4217)","example":"USD"},"payer":{"type":"object","description":"The provided data points for the transaction payer","properties":{"name":{"type":"string","description":"Payer/Payee name","example":"John Doe","minLength":1,"maxLength":100},"bankIdentifier":{"type":"string","description":"Bank identifier","example":"CHASEUS33","minLength":1,"maxLength":40},"branchIdentifier":{"type":"string","description":"Branch identifier","example":"123456","minLength":1,"maxLength":40},"accountNumber":{"type":"string","description":"Account number","example":"1234567890123456","minLength":1,"maxLength":100},"accountId":{"type":"string","description":"Unique identifier for the account","example":"USER_983245","minLength":1,"maxLength":100},"accountCountryCode":{"type":"string","description":"Country code of the account (ISO-3166-1 alpha-2)","example":"US","minLength":2,"maxLength":2},"card":{"type":"object","description":"Credit card details if applicable","properties":{"holderName":{"type":"string","description":"Name of the card holder","example":"John Doe","minLength":1,"maxLength":100},"bin":{"type":"string","description":"Bank Identification Number (first 6 digits of card)","example":"411111","minLength":6,"maxLength":8},"last4":{"type":"string","description":"Last 4 digits of the credit card number","example":"1234","minLength":4,"maxLength":4}}},"billingInfo":{"type":"object","description":"Billing address details","properties":{"name":{"type":"string","description":"Full name","example":"John Doe","minLength":1,"maxLength":100},"addressLine1":{"type":"string","description":"Address line 1","example":"123 Main St","minLength":1,"maxLength":255},"addressLine2":{"type":"string","description":"Address line 2","example":"Apt 4B","minLength":1,"maxLength":255},"city":{"type":"string","description":"City","example":"New York","minLength":1,"maxLength":100},"state":{"type":"string","description":"State/Province/Region","example":"NY","minLength":1,"maxLength":100},"zipPostalCode":{"type":"string","description":"ZIP or postal code","example":"10001","minLength":1,"maxLength":20},"country":{"type":"string","description":"Country code (ISO-3166-1 alpha-2)","example":"US","minLength":2,"maxLength":2},"email":{"type":"string","description":"Email address","example":"john.doe@example.com","minLength":3,"maxLength":255},"phone":{"type":"string","description":"Phone number","example":"+1234567890","minLength":1,"maxLength":30}}},"customerTier":{"type":"string","description":"Customer tier","example":"premium","minLength":1,"maxLength":50}}},"payee":{"type":"object","description":"The provided data points for the transaction payee","properties":{"name":{"type":"string","description":"Payer/Payee name","example":"John Doe","minLength":1,"maxLength":100},"bankIdentifier":{"type":"string","description":"Bank identifier","example":"CHASEUS33","minLength":1,"maxLength":40},"branchIdentifier":{"type":"string","description":"Branch identifier","example":"123456","minLength":1,"maxLength":40},"accountNumber":{"type":"string","description":"Account number","example":"1234567890123456","minLength":1,"maxLength":100},"accountId":{"type":"string","description":"Unique identifier for the account","example":"USER_983245","minLength":1,"maxLength":100},"accountCountryCode":{"type":"string","description":"Country code of the account (ISO-3166-1 alpha-2)","example":"US","minLength":2,"maxLength":2},"card":{"type":"object","description":"Credit card details if applicable","properties":{"holderName":{"type":"string","description":"Name of the card holder","example":"John Doe","minLength":1,"maxLength":100},"bin":{"type":"string","description":"Bank Identification Number (first 6 digits of card)","example":"411111","minLength":6,"maxLength":8},"last4":{"type":"string","description":"Last 4 digits of the credit card number","example":"1234","minLength":4,"maxLength":4}}}}},"channelId":{"type":"string","description":"Identifier for the channel used for the transaction","example":"MOBILE_APP","minLength":1,"maxLength":100},"transactionDate":{"type":"number","description":"The transaction timestamp (Unix epoch in milliseconds or seconds). Must be a non-negative integer.","example":1712594340000,"minimum":0},"purchase":{"type":"object","description":"Details about the purchase, if applicable","properties":{"totalItems":{"type":"number","description":"Total number of items in the purchase","example":3},"products":{"type":"array","description":"List of products in the purchase","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the product","example":"PROD_12345","minLength":1,"maxLength":100},"name":{"type":"string","description":"Name of the product","example":"iPhone 15","minLength":1,"maxLength":255},"amount":{"type":"number","description":"Amount of the product","example":1},"price":{"type":"number","description":"Price of the product","example":999.99}}}},"shippingInfo":{"type":"object","description":"Shipping address details","properties":{"name":{"type":"string","description":"Full name","example":"John Doe","minLength":1,"maxLength":100},"addressLine1":{"type":"string","description":"Address line 1","example":"123 Main St","minLength":1,"maxLength":255},"addressLine2":{"type":"string","description":"Address line 2","example":"Apt 4B","minLength":1,"maxLength":255},"city":{"type":"string","description":"City","example":"New York","minLength":1,"maxLength":100},"state":{"type":"string","description":"State/Province/Region","example":"NY","minLength":1,"maxLength":100},"zipPostalCode":{"type":"string","description":"ZIP or postal code","example":"10001","minLength":1,"maxLength":20},"country":{"type":"string","description":"Country code (ISO-3166-1 alpha-2)","example":"US","minLength":2,"maxLength":2},"email":{"type":"string","description":"Email address","example":"john.doe@example.com","minLength":3,"maxLength":255},"phone":{"type":"string","description":"Phone number","example":"+1234567890","minLength":1,"maxLength":30}}}}},"avs":{"type":"object","description":"Address Verification System (AVS) results","properties":{"code":{"type":"string","description":"AVS response code","example":"Y","minLength":1,"maxLength":10},"provider":{"type":"string","description":"AVS provider name","example":"Stripe","minLength":1,"maxLength":50},"matchLevel":{"type":"string","description":"AVS match level","enum":["none","postal","street","full","unknown"],"example":"full"}}}}},"custom_attributes":{"type":"object","description":"Custom attributes add context to an action but must match the schema defined in the Portal. Invalid attributes are ignored.","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}}},"components/schemas/triggerActionWithSessionToken":{"id":"components/schemas/triggerActionWithSessionToken","kind":"json-schema","title":"Using regular session token","data":{"title":"Using regular session token","allOf":[{"type":"object","required":["session_token"],"properties":{"session_token":{"type":"string","description":"A token returned by the SDK for the device session established upon SDK initialization."}}},{"$ref":"#/components/schemas/triggerActionBase"}]}},"components/schemas/triggerActionWithSecureSessionToken":{"id":"components/schemas/triggerActionWithSecureSessionToken","kind":"json-schema","title":"Using secure session token","data":{"title":"Using secure session token","allOf":[{"type":"object","required":["secured_session_token"],"properties":{"secured_session_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cryptographically signed token returned by the SDK's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getSecureSessionToken()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method. Provides enhanced security through device binding and anti-replay protection. Recommended for high-risk actions. Make sure to use the secure session token that matches the action type. Otherwise, the request will fail with 403 \"Action type mismatch\" error."},"children":[]}]}]}]}}},{"$ref":"#/components/schemas/triggerActionBase"}]}},"components/schemas/actionResult":{"id":"components/schemas/actionResult","kind":"json-schema","title":"actionResult","data":{"type":"object","required":["action_token","result"],"properties":{"action_token":{"type":"string","description":"The token return when the action event was reported"},"result":{"type":"string","enum":["success","failure","incomplete"],"description":"The action result."},"user_id":{"type":"string","description":"Opaque identifier of the user in your system."},"private_user_identifier":{"type":"string","description":"Identifier containing sensitive user data. Mosaic will encrypt and securely store this data."},"challenge_type":{"type":"string","enum":["sms_otp","email_otp","totp","push_otp","voice_otp","idv","captcha","invisible_captcha","password","passkey","document_verification","security_question","knowledge_based_authentication","device_approval","out_of_band","otp","device_biometrics","face_id","fingerprint","mobile_approve","pin","cap_rep_token","symantec_token","duo","secure_id","csm","biometric","devicetag_rep_token","email_verification","magic_link","symantec_pin","web_to_mobile"],"description":"Type of challenge used, in case a challenge was recommended for this action event"}}}},"components/schemas/authuser":{"id":"components/schemas/authuser","kind":"json-schema","title":"authuser","data":{"type":"object","required":["action_token","user_id"],"properties":{"user_id":{"type":"string","description":"Opaque identifier of the user in your system."},"action_token":{"type":"string","description":"The token return by the SDK when the action was reported."}}}},"components/schemas/clearUser":{"id":"components/schemas/clearUser","kind":"json-schema","title":"clearUser","data":{"oneOf":[{"$ref":"#/components/schemas/clearUserWithSessionToken"},{"$ref":"#/components/schemas/clearUserWithSecureSessionToken"}]}},"components/schemas/clearUserWithSessionToken":{"id":"components/schemas/clearUserWithSessionToken","kind":"json-schema","title":"Using regular session token","data":{"title":"Using regular session token","type":"object","required":["session_token"],"properties":{"session_token":{"type":"string","description":"A token returned by the SDK for the device session established upon SDK initialization."}}}},"components/schemas/clearUserWithSecureSessionToken":{"id":"components/schemas/clearUserWithSecureSessionToken","kind":"json-schema","title":"Using secure session token","data":{"title":"Using secure session token","type":"object","required":["secured_session_token"],"properties":{"secured_session_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cryptographically signed token returned by the SDK's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getSecureSessionToken()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method. Provides enhanced security through device binding and anti-replay protection."},"children":[]}]}]}]}}}},"components/schemas/setAssignee":{"id":"components/schemas/setAssignee","kind":"json-schema","title":"setAssignee","data":{"type":"object","properties":{"action_ids":{"type":"array","items":{"type":"string","description":"List of action IDs","example":"ea49707f023f48d64a7a817a2e7a5ff4277281a8f8ac1848ccac407967d9d2ce"}},"assignee":{"type":"string","description":"The email of the user to assign the actions to."}}}},"components/schemas/recommendation_type":{"id":"components/schemas/recommendation_type","kind":"json-schema","title":"recommendation_type","data":{"type":"string","description":"Recommendation type.","enum":["ALLOW","CHALLENGE","DENY","TRUST"],"example":"CHALLENGE"}},"components/schemas/result_type":{"id":"components/schemas/result_type","kind":"json-schema","title":"result_type","data":{"type":"string","description":"The outcome of the action.","enum":["success","failure","incomplete"],"example":"success"}},"components/schemas/challenge_type":{"id":"components/schemas/challenge_type","kind":"json-schema","title":"challenge_type","data":{"type":"string","description":"The type of challenge enforced for the reported action.","enum":["sms_otp","email_otp","totp","push_otp","voice_otp","idv","captcha","invisible_captcha","password","passkey","document_verification","security_question","knowledge_based_authentication","device_approval","out_of_band","otp","device_biometrics","face_id","fingerprint","mobile_approve","pin","cap_rep_token","symantec_token","duo","secure_id","csm","biometric","devicetag_rep_token","email_verification","magic_link","symantec_pin","web_to_mobile"],"example":"email_otp"}},"components/schemas/recommendation":{"id":"components/schemas/recommendation","kind":"json-schema","title":"recommendation","data":{"type":"object","description":"Decision the engine produced for the action.","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/recommendation_type"},"result":{"allOf":[{"$ref":"#/components/schemas/result_type"}],"nullable":true},"challenge_type":{"$ref":"#/components/schemas/challenge_type"}}}},"components/schemas/risk_score":{"id":"components/schemas/risk_score","kind":"json-schema","title":"risk_score","data":{"type":"number","description":"Used to assess the risk level of the action.","minimum":0,"maximum":100,"example":73.2}},"components/schemas/action_type":{"id":"components/schemas/action_type","kind":"json-schema","title":"action_type","data":{"type":"string","example":"login","description":"Type of client action this recommendation was issued for."}},"components/schemas/context":{"id":"components/schemas/context","kind":"json-schema","title":"context","data":{"type":"object","description":"Identifies the context in which the action occurred.","properties":{"action_id":{"type":"string","example":"885cd06b527a97498200560b67123fe221b5a39fd98d8d22cdb7ca8ec16ed62d","description":"Identifier of the client action."},"action_type":{"$ref":"#/components/schemas/action_type"},"action_performed_at":{"type":"integer","example":1648028118123,"description":"Unix epoch time in milliseconds the action event was reported."},"device_timestamp":{"type":"integer","example":1648028107819,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix epoch timestamp (ms) from the device clock when the action is triggered via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerActionEvent()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For backend-triggered actions, uses the server time. Used to correlate client and server events."},"children":[]}]}]}]},"client_id":{"type":"string","example":"d152ddd.ece93f4.c2a3d12.riskid.security","description":"Identifies the client associated with the action."},"application_id":{"type":"string","example":"ece93f4","description":"Identifies the application associated with the action."},"tenant_id":{"type":"string","example":"c2a3d12","description":"Identifies your tenant within Transmit."},"device_id":{"type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIwZGE4ZmZjYy01NmE1LTRmMjgtYThkZi04NDY5MmYwYThmYTAiLCJ2ZXJzaW9uIjoxLCJpYXQiOjE2NTU3OTYzODQ1MzF9.TeGoqlCe_6eWzl9a3-vAumG4Xap8WjwsgcO2-DzGtLg","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique device identifier generated by Transmit Security and stored by the SDK. On web, stored in the cookie. On mobile, uses platform-provided identifiers such as Android ID (hex string) or iOS "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifierForVendor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (alphanumeric). Not derived from IMEI or other hardware identifiers."},"children":[]}]}]}]},"correlation_id":{"type":"string","example":"bcb934d8-89cb-433b-a4c7-b7d94299586b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any ID that could help relate the action with external context or session (if set via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"triggerActionEvent()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SDK calls)."},"children":[]}]}]}]},"device_fingerprint":{"type":"string","example":"a3c8f5ea75cb65fcdc3d0452b985f957a46e24afdc912e93dac1e115ecf408e5","description":"Hash value on all the device data collected from the browser."},"device_public_key":{"type":"string","example":"625ad815e47a1a05318c98185ff8cfb35fd706d836a1ad7459842f381929a8e3","description":"A unique and persistent identifier derived from cryptographic binding."},"user_id":{"type":"string","example":"5c4afa75c","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque identifier of the user in your system (if set via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setAuthenticatedUser()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"init()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SDK calls)."},"children":[]}]}]}]},"claimed_user_id":{"type":"string","example":"5c4afa75c","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID of the not-yet-authenticated user, used to enhance risk and trust assessments. Once the user is authenticated, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"setAuthenticatedUser()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be called."},"children":[]}]}]}]},"location":{"type":"string","example":"https://www.amazingapp.com/shops?target=1","description":"The place in the application in which the action was performed (such as the page URL)."},"ip":{"type":"string","format":"ipv4","example":"160.221.187.219","description":"IP address."},"ip_country":{"type":"string","example":"US","description":"Country code, specified in a two-letter format (ISO 3166-1 alpha-2)."},"ip_location_region":{"type":"string","example":"California","description":"Location region identified by IP address."},"ip_domain":{"type":"string","example":"example.com","description":"Domain name resolved from IP address."},"ip_location_city":{"type":"string","example":"Los Angeles","description":"Location city identified by IP address."},"ip_location_zip":{"type":"string","example":"92131","description":"Location ZIP code identified by IP address."},"ip_location_longitude":{"type":"string","example":"-117.0903","description":"Geolocation longitude identified by IP address."},"ip_location_latitude":{"type":"string","example":"32.9167","description":"Geolocation latitude identified by IP address."},"ip_asn_id":{"type":"string","example":"AS174","description":"Globally unique identifier that defines a group of one or more IP prefixes."},"ip_asn_name":{"type":"string","example":"AS174 Cogent Communications","description":"ASN name of the IP address."},"ip_organization_name":{"type":"string","example":"Cogent Communications","description":"IP organization name."},"ip_organization_type":{"type":"string","example":"isp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of IP connection (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hosting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"ip_location_timezone":{"type":"string","example":"America/Los_Angeles","description":"Timezone location identified by IP address."},"device_timezone":{"type":"string","example":"America/Los_Angeles","description":"Timezone on device."},"device_languages":{"type":"array","items":{"type":"string"},"example":["en-US","en"],"description":"Languages on device."},"device_platform":{"type":"string","example":"desktop","description":"Type of device platform."},"os_name":{"type":"string","example":"macOS","description":"Name of the operating system."},"os_version":{"type":"string","example":"14.1.0","description":"Operating system version."},"browser_name":{"type":"string","example":"Chrome","description":"Name of the browser."},"browser_version":{"type":"string","example":"113","description":"Browser major version."},"user_agent":{"type":"string","example":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.90 Safari/537.36","description":"User agent string."}}}},"components/schemas/risk_signals":{"id":"components/schemas/risk_signals","kind":"json-schema","title":"risk_signals","data":{"type":"object","description":"Additional informative signals derived from the action.","properties":{"device":{"type":"object","description":"Device-relevant signals.","properties":{"ram":{"type":"number","description":"Device memory, a floating-point number."},"total_storage":{"type":"number","description":"Device total storage, as received from the mobile native platform."},"available_storage":{"type":"number","description":"Device available storage, as received from the mobile native platform."},"battery_level":{"type":"number","description":"Device battery level, a floating-point number."},"device_power_state":{"type":"string","description":"Indicates if the device is currently plugged into a power source."},"core_number":{"type":"number","description":"Device core number."},"graphic_card":{"type":"string","description":"Device graphics card, as received from the web platform."},"model":{"type":"string","description":"Device model."},"screen_width":{"type":"number","description":"Device screen width in pixels."},"screen_height":{"type":"number","description":"Device screen height in pixels."},"screen_pixel_depth":{"type":"number","description":"Pixel depth of the device screen."},"screen_color_depth":{"type":"number","description":"Color depth of the device screen."},"screen_avail_width":{"type":"number","description":"Available width of the screen."},"screen_avail_height":{"type":"number","description":"Available height of the screen."},"incognito":{"type":"boolean","description":"Whether the event was performed using incognito browsing."},"tampered":{"type":"boolean","description":"Whether the device is tampered (root or jailbreak)."},"emulated":{"type":"boolean","description":"Whether the device is emulated."},"spoofed":{"type":"boolean","description":"Whether the device is spoofed."},"tz_mismatch":{"type":"boolean","description":"Whether the event was performed on a device with a timezone mismatching expected."},"esim_usage":{"type":"boolean","description":"Whether the event was performed using eSIM."},"accept_languages":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept-language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header at the action request."},"children":[]}]}]}]},"mobile_network_code":{"type":"string","description":"String representation of the device's mobile carrier MCC and MNC."},"font_count":{"type":"number","description":"Number of fonts available on the device."},"cpu_arch":{"type":"string","description":"Device CPU architecture."},"navigator_useragent":{"type":"string","description":"User agent string from the device's browser navigator."},"true_useragent":{"type":"string","description":"User agent string reconstructed by the SDK, providing details about the browser, OS, and device."},"device_timezone_offset":{"type":"number","description":"Timezone offset of the device, in minutes from UTC."},"summer_timezone_offset":{"type":"number","description":"Device's timezone offset in minutes from UTC during daylight saving time."},"winter_timezone_offset":{"type":"number","description":"Device's timezone offset in minutes from UTC during standard time."},"device_name":{"type":"string","description":"Device's name as recorded on iOS, reflecting the user-set name."}}},"network":{"type":"object","description":"Network-relevant signals.","properties":{"vpn":{"type":"boolean","description":"Whether the event was performed using a VPN connection."},"tor":{"type":"boolean","description":"Whether the event was performed using a Tor connection."},"hosting":{"type":"boolean","description":"Whether the event was performed from a hosting provider."},"proxy":{"type":"boolean","description":"Whether the event was performed via a proxy."},"anonymizer":{"type":"boolean","description":"Whether the event was performed via an anonymizer."},"x_forwarded_for":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Forwarded-For"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header value, indicating the chain of intermediate proxies."},"children":[]}]}]}],"example":["160.221.187.219","52.23.177.192","172.70.34.26"]}}},"behavior":{"type":"object","description":"User-behavior-relevant signals.","properties":{"typing_velocity":{"type":"number","example":0.867,"description":"Percentile of user typing speed."},"movement_velocity":{"type":"number","example":10,"description":"Number of input events per second."},"input_method":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of used input methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_typing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard character-by-character keyboard text entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web, Mobile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_paste"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content inserted via paste (e.g. Ctrl/Cmd+V or context-menu paste)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web, Mobile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_autocomplete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value entered via an OS/keyboard autocomplete or autofill suggestion."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_password_manager"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value populated by a password manager / browser autofill."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_insert_replacement_text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing text replaced with a suggested value (e.g. spell-check/autocorrect or autofill replacement)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_insert_composition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text inserted from an in-progress IME composition (e.g. while composing CJK characters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_insert_from_composition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text committed (finalized) from an IME composition."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_insert_line_break"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line break was inserted (e.g. Shift+Enter)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_insert_from_drop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text inserted by dragging and dropping content into the field."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A deletion occurred (generic)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_content_backward"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion of the character before the cursor (Backspace)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_content_forward"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion of the character after the cursor (Delete key)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_content"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generic content deletion where direction is unspecified."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_word_backward"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion of the word before the cursor (e.g. Ctrl/Alt+Backspace)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_softline_backward"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion to the start of the current soft-wrapped line."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_hardline_backward"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion to the start of the current line/block (hard line boundary)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_by_cut"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content removed via Cut (e.g. Ctrl/Cmd+X)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_by_drag"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content removed by dragging it out of the field."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_delete_composition_text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion of in-progress IME composition text."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_history_undo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An undo action (e.g. Ctrl/Cmd+Z)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_history_redo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A redo action (e.g. Ctrl/Cmd+Y or Shift+Ctrl/Cmd+Z)."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]}]}]}]}],"example":["is_typing","is_paste"],"type":"array","items":{"type":"string"}},"no_user_interaction":{"type":"boolean","description":"Whether there was any user interaction before clicks."},"straight_line_ratio":{"type":"number","description":"Ratio of straight-line movements out of all movements in the action's context."},"right_angels_ratio":{"type":"number","description":"Ratio of right-angle movements out of all movements in the action's context."},"minor_angels_ratio":{"type":"number","description":"Ratio of minor-angle movements out of all movements in the action's context."},"movement_latency":{"type":"number","description":"Median delay of mouse or touchscreen movements (ms) within the action's context."},"corner_click":{"type":"boolean","description":"Whether there were multiple clicks on the corner of a button in the action's context."}}},"history":{"type":"object","description":"User-history-relevant signals.","properties":{"ip_action_rate_60_sec":{"type":"integer","example":7,"description":"Number of actions originating from the same client IP within 60 seconds prior to this action."},"user_action_rate_60_sec":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of actions with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within 60 seconds prior to this action."},"children":[]}]}]}]},"device_action_rate_60_sec":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of actions originating from the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within 60 seconds prior to this action."},"children":[]}]}]}]},"ip_user_count_last_hour":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s associated with the IP address within the previous hour."},"children":[]}]}]}]},"ip_device_count_last_hour":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s associated with the IP address within the previous hour."},"children":[]}]}]}]},"linking_device_to_users_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s associated with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linking_user_to_device_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of distinct "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s associated with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}}},"components/schemas/reasons":{"id":"components/schemas/reasons","kind":"json-schema","title":"reasons","data":{"type":"array","description":"Reasons that contributed to the recommendation.","items":{"type":"string"},"example":["BEHAVIOR_BOT","IP_RISKY_REPUTATION","DEVICE_SUSPICIOUS_ATTRIBUTE","PROFILE_DEVICE_NEW"]}},"components/schemas/transaction_type":{"id":"components/schemas/transaction_type","kind":"json-schema","title":"transaction_type","data":{"type":"string","description":"Transaction type.","enum":["purchase","bill_payment","mobile_recharge","money_transfer","credit_transfer","credit_redemption","top_up","withdrawal","investment","loan","refund","other"],"example":"purchase"}},"components/schemas/transaction_method":{"id":"components/schemas/transaction_method","kind":"json-schema","title":"transaction_method","data":{"type":"string","description":"Transaction method.","enum":["bank_account","wire","card","p2p","wallet"],"example":"card"}},"components/schemas/transaction_card":{"id":"components/schemas/transaction_card","kind":"json-schema","title":"transaction_card","data":{"type":"object","description":"Card-level identifiers for the party.","properties":{"holderName":{"type":"string","minLength":1,"maxLength":100,"example":"John Doe","description":"Name of the card holder."},"bin":{"type":"string","minLength":6,"maxLength":8,"example":"411111","description":"Bank Identification Number (first 6 digits of the card)."},"last4":{"type":"string","minLength":4,"maxLength":4,"example":"1234","description":"Last 4 digits of the credit card number."}}}},"components/schemas/transaction_party":{"id":"components/schemas/transaction_party","kind":"json-schema","title":"transaction_party","data":{"type":"object","description":"Shared shape for a transaction party (payee or payer).","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"example":"John Doe","description":"Party's name."},"accountNumber":{"type":"string","minLength":1,"maxLength":100,"example":"1234567890123456","description":"Party's account number."},"accountId":{"type":"string","minLength":1,"maxLength":100,"example":"USER_983245","description":"Unique identifier for the party's account."},"accountCountryCode":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","example":"US","description":"Country code of the account (ISO-3166-1 alpha-2)."},"bankIdentifier":{"type":"string","minLength":1,"maxLength":40,"example":"CHASEUS33","description":"Party's bank identifier."},"branchIdentifier":{"type":"string","minLength":1,"maxLength":40,"example":"123456","description":"Party's branch identifier."},"card":{"$ref":"#/components/schemas/transaction_card"}}}},"components/schemas/transaction_address":{"id":"components/schemas/transaction_address","kind":"json-schema","title":"transaction_address","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address and contact information (used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"name":{"type":"string","minLength":1,"maxLength":100,"example":"John Doe","description":"Full name."},"addressLine1":{"type":"string","minLength":1,"maxLength":255,"example":"123 Main St","description":"Address line 1."},"addressLine2":{"type":"string","minLength":1,"maxLength":255,"example":"Apt 4B","description":"Address line 2."},"city":{"type":"string","minLength":1,"maxLength":100,"example":"New York","description":"City."},"state":{"type":"string","minLength":1,"maxLength":100,"example":"NY","description":"State, province, or region."},"zipPostalCode":{"type":"string","minLength":1,"maxLength":20,"example":"10001","description":"ZIP or postal code."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","example":"US","description":"Country code (ISO-3166-1 alpha-2)."},"email":{"type":"string","minLength":3,"maxLength":255,"example":"john.doe@example.com","description":"Email address."},"phone":{"type":"string","minLength":1,"maxLength":30,"example":"+1234567890","description":"Phone number."}}}},"components/schemas/transaction_payer":{"id":"components/schemas/transaction_payer","kind":"json-schema","title":"transaction_payer","data":{"allOf":[{"$ref":"#/components/schemas/transaction_party"}],"type":"object","description":"Payer party of the transaction. Adds customer-tier and billing-info fields on top of the shared party shape.","properties":{"customerTier":{"type":"string","minLength":1,"maxLength":50,"example":"premium","description":"Payer's customer tier."},"billingInfo":{"$ref":"#/components/schemas/transaction_address"}}}},"components/schemas/transaction_payee":{"id":"components/schemas/transaction_payee","kind":"json-schema","title":"transaction_payee","data":{"allOf":[{"$ref":"#/components/schemas/transaction_party"}],"description":"Payee party of the transaction."}},"components/schemas/transaction_product":{"id":"components/schemas/transaction_product","kind":"json-schema","title":"transaction_product","data":{"type":"object","description":"A single product line item.","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"example":"PROD_12345","description":"Unique identifier for the product."},"name":{"type":"string","minLength":1,"maxLength":255,"example":"iPhone 15","description":"Name of the product."},"amount":{"type":"integer","minimum":1,"example":1,"description":"Quantity of this product line item."},"price":{"type":"number","minimum":0,"example":999.99,"description":"Price per unit of the product."}}}},"components/schemas/transaction_purchase":{"id":"components/schemas/transaction_purchase","kind":"json-schema","title":"transaction_purchase","data":{"type":"object","description":"Purchase details for the transaction.","properties":{"totalItems":{"type":"integer","minimum":1,"example":3,"description":"Total number of items in the purchase."},"products":{"type":"array","description":"Line items in the purchase.","items":{"$ref":"#/components/schemas/transaction_product"}},"shippingInfo":{"$ref":"#/components/schemas/transaction_address"}}}},"components/schemas/avs_match_level":{"id":"components/schemas/avs_match_level","kind":"json-schema","title":"avs_match_level","data":{"type":"string","description":"AVS match level.","enum":["none","postal","street","full","unknown"],"example":"full"}},"components/schemas/transaction_avs":{"id":"components/schemas/transaction_avs","kind":"json-schema","title":"transaction_avs","data":{"type":"object","description":"Address Verification Service result for the transaction.","properties":{"code":{"type":"string","minLength":1,"maxLength":10,"example":"Y","description":"AVS response code."},"provider":{"type":"string","minLength":1,"maxLength":50,"example":"Stripe","description":"AVS provider name."},"matchLevel":{"$ref":"#/components/schemas/avs_match_level"}}}},"components/schemas/transaction_data":{"id":"components/schemas/transaction_data","kind":"json-schema","title":"transaction_data","data":{"type":"object","description":"Transaction data-points provided with the action via the SDK.","properties":{"amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monetary amount of the transaction. Sanitized server-side with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parseFloat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; must be strictly positive and at most 999,999,999.99."},"children":[]}]}]}],"exclusiveMinimum":0,"maximum":999999999.99,"example":1500.75},"currency":{"type":"string","example":"USD","description":"Currency code for the transaction (ISO-4217)."},"type":{"$ref":"#/components/schemas/transaction_type"},"method":{"$ref":"#/components/schemas/transaction_method"},"channelId":{"type":"string","minLength":1,"maxLength":100,"example":"MOBILE_APP","description":"Identifier for the channel used for the transaction."},"reason":{"type":"string","minLength":1,"maxLength":200,"example":"Monthly subscription payment","description":"Reason for the transaction."},"transactionDate":{"type":"integer","minimum":0,"example":1712594340000,"description":"Transaction timestamp (Unix epoch, milliseconds or seconds)."},"payer":{"$ref":"#/components/schemas/transaction_payer"},"payee":{"$ref":"#/components/schemas/transaction_payee"},"purchase":{"$ref":"#/components/schemas/transaction_purchase"},"avs":{"$ref":"#/components/schemas/transaction_avs"}}}},"components/schemas/custom_attributes":{"id":"components/schemas/custom_attributes","kind":"json-schema","title":"custom_attributes","data":{"type":"object","description":"Tenant-defined custom attributes attached to the action. These add context to an action but must match the schema defined in the Admin Portal. Invalid attributes are ignored and not included in the response.\n","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},"components/schemas/threats":{"id":"components/schemas/threats","kind":"json-schema","title":"threats","data":{"type":"array","description":"List of all detected threats.","items":{"type":"string"},"example":["ACCOUNT_TAKEOVER","NEW_FRAUD_ACCOUNT"]}},"components/schemas/preview_rule":{"id":"components/schemas/preview_rule","kind":"json-schema","title":"preview_rule","data":{"type":"object","description":"Rule configured in preview mode that would have determined this action's recommendation if all enabled rules were in production. Useful for impact analysis without changing live behavior.\n","properties":{"rule_name":{"type":"string","description":"Name of the preview rule."},"recommendation":{"type":"string","description":"Recommendation the preview rule would have applied.","enum":["ALLOW","CHALLENGE","DENY","TRUST"]},"risk_score":{"type":"number","description":"Risk score the preview rule would have applied."}}}},"components/schemas/recommendation_full":{"id":"components/schemas/recommendation_full","kind":"json-schema","title":"recommendation_full","data":{"type":"object","description":"Recommendation","required":["id","issued_at","recommendation","risk_score","context","reasons"],"properties":{"id":{"type":"string","example":"385cd06b527a974982e0560b67123fe2b1b5a39fd98d8d32cdbaca8ec16fd62d","description":"Recommendation identifier"},"issued_at":{"type":"number","example":1648028118123,"description":"Unix epoch time in milliseconds this recommendation was issued at"},"recommendation":{"$ref":"#/components/schemas/recommendation"},"risk_score":{"$ref":"#/components/schemas/risk_score"},"context":{"allOf":[{"$ref":"#/components/schemas/context"},{"type":"object","required":["action_id","action_type","action_performed_at","device_id","device_fingerprint","application_id"]}]},"risk_signals":{"$ref":"#/components/schemas/risk_signals"},"reasons":{"$ref":"#/components/schemas/reasons"},"transaction_data":{"$ref":"#/components/schemas/transaction_data"},"custom_attributes":{"$ref":"#/components/schemas/custom_attributes"},"threats":{"$ref":"#/components/schemas/threats"},"preview_rule":{"$ref":"#/components/schemas/preview_rule"}}}},"schema_294":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"object","required":["action_token"],"properties":{"action_token":{"type":"string"},"recommendation":{"$ref":"#/components/schemas/recommendation_full"}}},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Defines if the operation was successful.","example":true},"message":{"type":"string","description":"A human-readable confirmation message.","example":"User has been cleared."}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Defines if the operation was successful."},"affectedActionsCount":{"type":"number","example":4,"description":"The number of assigned actions."}}},"id":"schema_297"}},"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/client-actions.openapi.json?download"},{"url":"/_bundle/openapi/risk/client-actions.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Client Actions","description":"This backend API is used to report client actions, add the user context and report action results, allowing Fraud Prevention reporting and user profiling."}},"baseSlug":"/openapi/risk/client-actions.openapi","routesMapping":{}}