Lists

Lists APIs provided by Fraud Prevention are used to organize recommendations into categories and manage them.

Download OpenAPI description

list.openapi.json

list.openapi.yaml

Servers

Sandbox environment

https://api.sbx.transmitsecurity.io/risk/v1/

Production environment (US)

https://api.transmitsecurity.io/risk/v1/

Production environment (EU)

https://api.eu.transmitsecurity.io/risk/v1/

Production environment (CA)

https://api.ca.transmitsecurity.io/risk/v1/

Production environment (AU)

https://api.au.transmitsecurity.io/risk/v1/

Create list

Request

Creates a new recommendation list.

Security

risk_access_token

Bodyapplication/jsonrequired

list_namestringrequired

The list title.

list_typestringrequired

The type of recommendation list.

Value"action_id"

creatorstringrequired

The list owner.

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/risk/v1/lists \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "list_name": "string",
    "list_type": "action_id",
    "creator": "string"
  }'

Responses

List

Bodyapplication/json

list_namestringrequired

The list title.

tenant_idstringrequired

ID of the tenant.

list_typestringrequired

The type of recommendation list.

Value"action_id"

creatorstringrequired

The list owner.

list_idstringrequired

ID of the recommendation list.

itemsArray of objectsrequired

items[].item_idstringrequired

ID of the list item.

items[].item_created_timestampstring(date-time)required

The timestamp when the item was added to the list.

created_datestring(date-time)required

The timestamp when the list was created.

updated_datestring(date-time)required

The timestamp when the list was updated.

Response

application/json

{
  "list_name": "string",
  "tenant_id": "string",
  "list_type": "action_id",
  "creator": "string",
  "list_id": "string",
  "items": [
    { … }
  ],
  "created_date": "2019-08-24T14:15:22Z",
  "updated_date": "2019-08-24T14:15:22Z"
}

Get all lists

Request

Retrieves all lists of the tenant. To return lists that include a specific recommendation, add item_id to the query.

Security

risk_access_token

Query

item_idstring

ID of the list item.

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists?item_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Matching lists

Bodyapplication/jsonArray [

list_namestringrequired

The list title.

tenant_idstringrequired

ID of the tenant.

list_typestringrequired

The type of recommendation list.

Value"action_id"

creatorstringrequired

The list owner.

list_idstringrequired

ID of the recommendation list.

itemsArray of objectsrequired

items[].item_idstringrequired

ID of the list item.

items[].item_created_timestampstring(date-time)required

The timestamp when the item was added to the list.

created_datestring(date-time)required

The timestamp when the list was created.

updated_datestring(date-time)required

The timestamp when the list was updated.

]

Response

application/json

[
  {
    "list_name": "string",
    "tenant_id": "string",
    "list_type": "action_id",
    "creator": "string",
    "list_id": "string",
    "items": [ … ],
    "created_date": "2019-08-24T14:15:22Z",
    "updated_date": "2019-08-24T14:15:22Z"
  }
]

Get list

Request

Retrieves a specific list by its ID.

Security

risk_access_token

Path

list_idstringrequired

ID of the recommendation list.

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists/{list_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List

Bodyapplication/json

list_namestringrequired

The list title.

tenant_idstringrequired

ID of the tenant.

list_typestringrequired

The type of recommendation list.

Value"action_id"

creatorstringrequired

The list owner.

list_idstringrequired

ID of the recommendation list.

itemsArray of objectsrequired

items[].item_idstringrequired

ID of the list item.

items[].item_created_timestampstring(date-time)required

The timestamp when the item was added to the list.

created_datestring(date-time)required

The timestamp when the list was created.

updated_datestring(date-time)required

The timestamp when the list was updated.

Response

application/json

{
  "list_name": "string",
  "tenant_id": "string",
  "list_type": "action_id",
  "creator": "string",
  "list_id": "string",
  "items": [
    { … }
  ],
  "created_date": "2019-08-24T14:15:22Z",
  "updated_date": "2019-08-24T14:15:22Z"
}

Update list

Request

Updates a specific list. Currently, you can update a list name.

Path

list_idstringrequired

ID of the recommendation list.

Query

list_namestringrequired

The list title.

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists/{list_id}?list_name=string'

Responses

List

Bodyapplication/json

list_namestringrequired

The list title.

tenant_idstringrequired

ID of the tenant.

list_typestringrequired

The type of recommendation list.

Value"action_id"

creatorstringrequired

The list owner.

list_idstringrequired

ID of the recommendation list.

itemsArray of objectsrequired

items[].item_idstringrequired

ID of the list item.

items[].item_created_timestampstring(date-time)required

The timestamp when the item was added to the list.

created_datestring(date-time)required

The timestamp when the list was created.

updated_datestring(date-time)required

The timestamp when the list was updated.

Response

application/json

{
  "list_name": "string",
  "tenant_id": "string",
  "list_type": "action_id",
  "creator": "string",
  "list_id": "string",
  "items": [
    { … }
  ],
  "created_date": "2019-08-24T14:15:22Z",
  "updated_date": "2019-08-24T14:15:22Z"
}

Delete list

Request

Removes a recommendation list by its ID.

Path

list_idstringrequired

ID of the recommendation list.

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists/{list_id}'

Responses

Success

Bodyapplication/json

messagestringrequired

Response

application/json

{
  "message": "string"
}

Add to list

Request

Adds recommendations to the specific list.

Path

list_idstringrequired

ID of the recommendation list.

Bodyapplication/jsonrequired

item_idsArray of stringsrequired

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists/{list_id}/items' \
  -H 'Content-Type: application/json' \
  -d '{
    "item_ids": [
      "string"
    ]
  }'

Responses

List contents

Bodyapplication/json

list_idstringrequired

ID of the recommendation list.

tenant_idstringrequired

ID of the tenant.

added_datestring(date-time)required

The timestamp the items were added.

itemsArray of objectsrequired

items[].item_idstringrequired

ID of the list item.

items[].item_created_timestampstring(date-time)required

The timestamp when the item was added to the list.

Response

application/json

{
  "list_id": "string",
  "tenant_id": "string",
  "added_date": "2019-08-24T14:15:22Z",
  "items": [
    { … }
  ]
}

Remove item from list

Request

Removes a specific item from the list.

Path

list_idstringrequired

ID of the recommendation list.

item_idstringrequired

ID of the item to be removed.

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/risk/v1/lists/{list_id}/items/{item_id}'

Responses

Success

Bodyapplication/json

messagestringrequired

Response

application/json

{
  "message": "string"
}