{"items":[{"type":"link","label":"Lists","link":"/openapi/risk/list.openapi","routeSlug":"/openapi/risk/list.openapi","content":{"contentType":"overview","meta":{"name":"Lists"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"list.openapi.json","url":"/_bundle/openapi/risk/list.openapi.json?download"},{"kind":"download","label":"list.openapi.yaml","url":"/_bundle/openapi/risk/list.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":"Lists","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Lists APIs provided by Fraud Prevention are used to organize recommendations into categories and manage them."}],"sectionId":"/openapi/risk/list.openapi"}],"sectionId":"/openapi/risk/list.openapi"}]}]}},{"label":"Create list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/createlist","routeSlug":"/openapi/risk/list.openapi/other/createlist","metadata":{"seo":{"title":"Create list","description":"Creates a new recommendation list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createList","name":"Create list","isWebhook":false,"pointer":"/paths/~1lists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new recommendation list."},{"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/list_api_request"}},"schemaId":"components/schemas/list_api_request","pointer":"/paths/~1lists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lists","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/list_api_request"}},"responseCodes":["201","400","401","403","409","429","500"],"pointer":"/lists","href":"other/createlist","openApiOperationId":"createList","summary":"Create list"},"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/list_api_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/list_api_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_api_response"}},"schemaId":"components/schemas/list_api_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"409","description":"Unique field collision"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/list_api_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_api_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/lists"},{"label":"Get all lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/getlists","routeSlug":"/openapi/risk/list.openapi/other/getlists","metadata":{"seo":{"title":"Get all lists","description":"Retrieves all lists of the tenant. To return lists that include a specific recommendation, add item_id  to the query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLists","name":"Get all lists","isWebhook":false,"pointer":"/paths/~1lists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all lists of the tenant. To return lists that include a specific recommendation, add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  to the query."},"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":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"item_id","in":"query","schemaId":"schema_295","description":"ID of the list item."}],"pointer":"/paths/~1lists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lists","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":"item_id","in":"query","required":false,"schemaId":"schema_295"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lists","href":"other/getlists","openApiOperationId":"getLists","summary":"Get all lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Matching lists","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 (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/lists"},{"label":"Get list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/getlist","routeSlug":"/openapi/risk/list.openapi/other/getlist","metadata":{"seo":{"title":"Get list","description":"Retrieves a specific list by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getList","name":"Get list","isWebhook":false,"pointer":"/paths/~1lists~1{list_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific list by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"risk_access_token","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token generated by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_295","description":"ID of the recommendation list.","required":true}],"pointer":"/paths/~1lists~1{list_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lists/{list_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_295"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"risk_access_token","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lists/{list_id}","href":"other/getlist","openApiOperationId":"getList","summary":"Get list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_api_response"}},"schemaId":"components/schemas/list_api_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists~1{list_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list_api_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_api_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/lists/{list_id}"},{"label":"Update list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/updatelist","routeSlug":"/openapi/risk/list.openapi/other/updatelist","metadata":{"seo":{"title":"Update list","description":"Updates a specific list. Currently, you can update a list name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateList","name":"Update list","isWebhook":false,"pointer":"/paths/~1lists~1{list_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a specific list. Currently, you can update a list name."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_295","description":"ID of the recommendation list.","required":true}],"pointer":"/paths/~1lists~1{list_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"list_name","in":"query","schemaId":"schema_295","description":"The list title.","required":true}],"pointer":"/paths/~1lists~1{list_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/lists/{list_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_295"}],"query":[{"name":"list_name","in":"query","required":true,"schemaId":"schema_295"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lists/{list_id}","href":"other/updatelist","openApiOperationId":"updateList","summary":"Update list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_api_response"}},"schemaId":"components/schemas/list_api_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"409","description":"Unique field collision"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists~1{list_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list_api_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_api_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/lists/{list_id}"},{"label":"Delete list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/removelist","routeSlug":"/openapi/risk/list.openapi/other/removelist","metadata":{"seo":{"title":"Delete list","description":"Removes a recommendation list by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeList","name":"Delete list","isWebhook":false,"pointer":"/paths/~1lists~1{list_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a recommendation list by its ID."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_295","description":"ID of the recommendation list.","required":true}],"pointer":"/paths/~1lists~1{list_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/lists/{list_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_295"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lists/{list_id}","href":"other/removelist","openApiOperationId":"removeList","summary":"Delete list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","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 (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists~1{list_id}/delete/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":"/lists/{list_id}"},{"label":"Add to list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/additems","routeSlug":"/openapi/risk/list.openapi/other/additems","metadata":{"seo":{"title":"Add to list","description":"Adds recommendations to the specific list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addItems","name":"Add to list","isWebhook":false,"pointer":"/paths/~1lists~1{list_id}~1items/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add to list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds recommendations to the specific list."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_295","description":"ID of the recommendation list.","required":true}],"pointer":"/paths/~1lists~1{list_id}~1items/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/list_items_api_request"}},"schemaId":"components/schemas/list_items_api_request","pointer":"/paths/~1lists~1{list_id}~1items/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lists/{list_id}/items","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_295"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/list_items_api_request"}},"responseCodes":["201","400","401","403","404","409","429","500"],"pointer":"/lists/{list_id}/items","href":"other/additems","openApiOperationId":"addItems","summary":"Add to list"},"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/list_items_api_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/list_items_api_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"List contents","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_items_api_response"}},"schemaId":"components/schemas/list_items_api_response"},{"code":"400","description":"Bad request"},{"code":"401","description":"Invalid authentication"},{"code":"403","description":"Invalid authorization (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"409","description":"Unique field collision"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists~1{list_id}~1items/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/list_items_api_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list_items_api_response"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]}]},"httpPath":"/lists/{list_id}/items"},{"label":"Remove item from list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/risk/list.openapi/other/removeitem","routeSlug":"/openapi/risk/list.openapi/other/removeitem","metadata":{"seo":{"title":"Remove item from list","description":"Removes a specific item from the list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeItem","name":"Remove item from list","isWebhook":false,"pointer":"/paths/~1lists~1{list_id}~1items~1{item_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove item from list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a specific item from the list."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"list_id","in":"path","schemaId":"schema_295","description":"ID of the recommendation list.","required":true},{"name":"item_id","in":"path","schemaId":"schema_295","description":"ID of the item to be removed.","required":true}],"pointer":"/paths/~1lists~1{list_id}~1items~1{item_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/lists/{list_id}/items/{item_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"parameters":{"path":[{"name":"list_id","in":"path","required":true,"schemaId":"schema_295"},{"name":"item_id","in":"path","required":true,"schemaId":"schema_295"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lists/{list_id}/items/{item_id}","href":"other/removeitem","openApiOperationId":"removeItem","summary":"Remove item from list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/risk/v1","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/risk/v1","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/risk/v1","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/risk/v1","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/risk/v1","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/risk/v1","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","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 (e.g, unauthorized resource)"},{"code":"404","description":"Not found"},{"code":"429","description":"Rate limit reached"},{"code":"500","description":"Internal error"}],"pointer":"/paths/~1lists~1{list_id}~1items~1{item_id}/delete/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":"/lists/{list_id}/items/{item_id}"}],"store":{"schemaStore":{"components/schemas/list_type":{"id":"components/schemas/list_type","kind":"json-schema","title":"list_type","data":{"type":"string","description":"The type of recommendation list.","enum":["action_id"]}},"components/schemas/list_api_request":{"id":"components/schemas/list_api_request","kind":"json-schema","title":"list_api_request","data":{"type":"object","properties":{"list_name":{"type":"string","description":"The list title."},"list_type":{"$ref":"#/components/schemas/list_type"},"creator":{"type":"string","description":"The list owner."}},"required":["list_name","list_type","creator"]}},"components/schemas/list_items_api_request":{"id":"components/schemas/list_items_api_request","kind":"json-schema","title":"list_items_api_request","data":{"type":"object","properties":{"item_ids":{"type":"array","items":{"type":"string","description":"ID of the list item."}}},"required":["item_ids"]}},"components/schemas/list_items_metadata_api_response":{"id":"components/schemas/list_items_metadata_api_response","kind":"json-schema","title":"list_items_metadata_api_response","data":{"type":"object","properties":{"item_id":{"type":"string","description":"ID of the list item."},"item_created_timestamp":{"format":"date-time","type":"string","description":"The timestamp when the item was added to the list."}},"required":["item_id","item_created_timestamp"]}},"components/schemas/list_api_response":{"id":"components/schemas/list_api_response","kind":"json-schema","title":"list_api_response","data":{"type":"object","properties":{"list_name":{"type":"string","description":"The list title."},"tenant_id":{"type":"string","description":"ID of the tenant."},"list_type":{"$ref":"#/components/schemas/list_type"},"creator":{"type":"string","description":"The list owner."},"list_id":{"type":"string","description":"ID of the recommendation list."},"items":{"type":"array","items":{"$ref":"#/components/schemas/list_items_metadata_api_response"}},"created_date":{"format":"date-time","type":"string","description":"The timestamp when the list was created."},"updated_date":{"format":"date-time","type":"string","description":"The timestamp when the list was updated."}},"required":["list_name","tenant_id","list_type","creator","list_id","items","created_date","updated_date"]}},"components/schemas/list_items_api_response":{"id":"components/schemas/list_items_api_response","kind":"json-schema","title":"list_items_api_response","data":{"type":"object","properties":{"list_id":{"type":"string","description":"ID of the recommendation list."},"tenant_id":{"type":"string","description":"ID of the tenant."},"added_date":{"format":"date-time","type":"string","description":"The timestamp the items were added."},"items":{"type":"array","items":{"$ref":"#/components/schemas/list_items_metadata_api_response"}}},"required":["list_id","tenant_id","added_date","items"]}},"schema_295":{"kind":"json-schema","data":{"type":"string"},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/list_api_response"}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"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/list.openapi.json?download"},{"url":"/_bundle/openapi/risk/list.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Lists","description":"Lists APIs provided by Fraud Prevention are used to organize recommendations into categories and manage them."}},"baseSlug":"/openapi/risk/list.openapi","routesMapping":{}}