Overview

Use this method to add custom tags to transactions.

Tags can be used to categorize and identify transactions. They are especially beneficial to perform ongoing risk assessment for more granular transaction risk scoring.

📘

Notes

• You can only add tags that are created and stored in the Dashboard settings.
• Tag names are case sensitive. For example, Suspicious and suspicious are considered different.

Request example

curl -X POST \
     'https://api.sumsub.com/resources/kyt/txns/66c46d7566f5244e45a81167/tags' \
     -H 'content-type: application/json' \
     -d '["Structuring", "Anomaly med", "Bonus abuse", "Suspicious pattern"]'

Response explained

The response is a JSON file with an array of objects representing new tags. Each object stands for a single tag.

The following table explains the element fields within the response.

Response examples

The following is an example of the response where tags are successfully added to the transaction.

[
  {
    "label": "Structuring",
    "type": "userDefined"
  },
  {
    "label": "Anomaly med",
    "type": "userDefined"
  },
  {
    "label": "Bonus abuse",
    "type": "userDefined"
  },
  {
    "label": "Suspicious pattern",
    "type": "userDefined"
  }
]

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error.

For example:

{
  "description": "Tags [bonus abuse, suspicious pattern] are not set in the settings",
  "code": 400,
  "correlationId": "ca5566bc06a7b541ed77bdf00b3232c4"
}