# KYT

# KYT API Reference

Also, pay attention to the failed requests. Error descriptions can be found here.

# Process transaction for existing applicant

POST /resources/applicants/{applicantId}/kyt/txns/-/data

# REQUEST ARGUMENTS

# REQUEST BODY

# info ELEMENT ATTRIBUTES

# applicant AND counterparty ELEMENTS ATTRIBUTES

# institutionInfo ELEMENT ATTRIBUTES

# paymentMethod ELEMENT ATTRIBUTES

# gamblingBet ELEMENT ATTRIBUTES

# gamblingLimitChange ELEMENT ATTRIBUTES

# device ELEMENT ATTRIBUTES

# coords ELEMENT ATTRIBUTES

# ipInfo ELEMENT ATTRIBUTES

# Example request

curl -X POST \
  'https://api.sumsub.com/resources/applicants/631f268442d8290001e1eee9/kyt/txns/-/data' \
  -H 'Content-Type: application/json' \
  -d '{
        "txnId": "631f268442d8290001e1eee9_newTxn",
        "applicant": {
            "externalUserId": "uniqueRemitterId",
            "address": {
                "country": "DEU",
                "street": "Chauseestr. 60",
                "postCode": "101115",
                "town": "Berlin"
            },
            "device": {
                "ipInfo": {
                    "ip": "87.141.63.130"
                }
            },
            "institutionInfo": {
                "code": "DEUTDEDB101",
                "name": "Deutsche Bank"
            },
            "paymentMethod": {
                "type": "card",
                "accountId": "eg_hash_of_credit_card_number",
                "issuingCountry": "GBR"
            }
        },
        "counterparty": {
            "externalUserId": "uniqueBeneficiaryId",
            "fullName": "John Smith",
            "type": "individual",
            "institutionInfo": {
                "code": "CRESCHZZXXX",
                "name": "Credit Swiss (Schweiz)"
            }
        },
        "info": {
            "direction": "out",
            "amount": 101.42,
            "currencyCode": "GBP",
            "cryptoChain": "TRX",
            "paymentTxnId": "84bf83c10dfddc9d1f0ea6a1a131c638488fb161e819dae25fd8128c671d2d5a",
            "paymentDetails": "Birthday Present"
        },
        "props": {
            "customProperty": "Custom value that can be used in rules"
        }
    }'

# RESPONSE ATTRIBUTES

Response contains the information from created transaction (all attributes) above, with data object and additional objects that contain current review and scoring info of transaction.

# RESPONSE ATTRIBUTES

# review ELEMENT ATTRIBUTES

# scoringResult ELEMENT ATTRIBUTES

# matchedRules ELEMENTS ATTRIBUTES

# Example response

{
    "id": "638f1e3656df2d000138bff0",
    "applicantId": "631f268442d8290001e1eee9",
    "data": {
        "txnId": "631f268442d8290001e1eee9_newTxn",
        "applicant": {
            "address": {
                "country": "DEU",
                "street": "Chauseestr. 60",
                "postCode": "101115",
                "town": "Berlin"
            },
            "device": {
                "ipInfo": {
                    "ip": "87.141.63.130"
                }
            },
            "institutionInfo": {
                "code": "DEUTDEDB101",
                "name": "Deutsche Bank"
            }
        },
        "counterparty": {
            "fullName": "John Smith",
            "type": "individual",
            "institutionInfo": {
                "code": "CRESCHZZXXX",
                "name": "Credit Swiss (Schweiz)"
            }
        },
        "info": {
            "direction": "out",
            "amount": 10100.42,
            "currencyCode": "GBP",
            "paymentDetails": "Birthday Present"
        },
        "props": {
            "customProperty": "Custom value that can be used in rules"
        }
    },
    "review": {
      "reviewStatus": "onHold"
    },
    "scoringResult": {
      "matchedRules": [
        {
          "id": "6391b0d1ac5401000190cf02",
          "name": "PAAM2",
          "title": "Large amount",
          "score": 30,
          "action": "onHold"
        },
        {
          "id": "6391b0b2d8f0730001bea772",
          "name": "PATX15",
          "title": "Average amount for the same beneficiary for the last month is greater by 35% of average amount for last 3 months",
          "score": 5,
          "action": "score"
        }
      ],
      "action": "onHold"
  }
}

# Getting transaction

GET /resources/kyt/txns/{id}/one

# REQUEST ARGUMENTS

# RESPONSE ATTRIBUTES

Response contains the info from created transaction (all attributes) above with additional objects that contain current review and scoring info of requested transaction.

# Example response

{
    "id": "638f1e3656df2d000138bff0",
    "applicantId": "631f268442d8290001e1eee9",
    "data": {
        "txnId": "631f268442d8290001e1eee9_newTxn",
        "applicant": {
            "address": {
                "country": "DEU",
                "street": "Chauseestr. 60",
                "postCode": "101115",
                "town": "Berlin"
            },
            "device": {
                "ipInfo": {
                    "ip": "87.141.63.130"
                }
            },
            "institutionInfo": {
                "code": "DEUTDEDB101",
                "name": "Deutsche Bank"
            }
        },
        "counterparty": {
            "fullName": "John Smith",
            "type": "individual",
            "institutionInfo": {
                "code": "CRESCHZZXXX",
                "name": "Credit Swiss (Schweiz)"
            }
        },
        "info": {
            "direction": "out",
            "amount": 101.42,
            "currencyCode": "GBP",
            "paymentDetails": "Birthday Present"
        },
        "props": {
            "customProperty": "Custom value that can be used in rules"
        }
    },
    "review": {
      "reviewStatus": "onHold"
    }
}

# Bulk transaction import

This endpoint allows you to import a list of transactions to your dashboards for our service to consider them in the next transactions processing for scoring. It expects transactions to be passed in valid NDJSON with the Content-Type: application/x-ndjson header being set.

POST /resources/kyt/misc/txns/import

# REQUEST BODY

The list of JSON strings representing a KYT transaction divided by \n is expected.

Transaction object contains properties below:

# Example request

curl -X POST \
  'https://api.sumsub.com/resources/kyt/misc/txns/import' \
  -H 'Content-Type: application/x-ndjson' \
  -d $'{
          "applicantId": "636cee6b17d6c7000144673b",
          "data": {
            "txnId": "631f268442d8290001e1eee8_newTxn",
            "applicant": {
              "externalUserId": "uniqueRemitterId",
              "address": {
                "country": "DEU",
                "street": "Chauseestr. 60",
                "postCode": "101115",
                "town": "Berlin"
              },
              "device": {
                "ipInfo": {
                    "ip": "87.141.63.130"
                }
              },
              "institutionInfo": {
                "code": "DEUTDEDB101",
                "name": "Deutsche Bank"
              }
            },
            "counterparty": {
              "externalUserId": "uniqueBeneficiaryId",
              "fullName": "John Smith",
              "type": "individual",
              "institutionInfo": {
                "code": "CRESCHZZXXX",
                "name": "Credit Swiss (Schweiz)"
              }
            },
            "info": {
              "direction": "in",
              "amount": 101.42,
              "currencyCode": "GBP",
              "paymentDetails": "Birthday Present"
            }
          }
    }\n{
          "applicantId": "636cee6b17d6c7000144673b",
          "data": {
            "txnId": "631f268442d8290001e1eee9_newTxn",
            "applicant": {
              "externalUserId": "uniqueRemitterId",
              "address": {
                "country": "DEU",
                "street": "Chauseestr. 60",
                "postCode": "101115",
                "town": "Berlin"
              },
              "institutionInfo": {
                "code": "DEUTDEDB101",
                "name": "Deutsche Bank"
              }
            },
            "counterparty": {
              "externalUserId": "uniqueBeneficiaryId",
              "fullName": "John Smith",
              "type": "individual"
            },
            "info": {
              "direction": "out",
              "amount": 101.42,
              "currencyCode": "GBP",
              "paymentDetails": "Birthday Present"
            }
          }
      }'

# RESPONSE ATTRIBUTES

Response contains a number of imported transactions.

# Example response

{
    "createdCnt": 2
}

# Changing transaction custom properties

For the cases when some parameter is needed to be added to the transaction, we provide a possibility to do so via method below. Its scope is restricted, and not all fields can be changed.

PATCH /resources/kyt/txns/{id}/props?unsetKeys={unsetKeys}

# REQUEST ARGUMENTS

# Example request

curl -X POST \
  'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/props?unsetKeys=customProp1,customProp2' \
  -H 'Content-Type: application/json' \
  -d '{
        "customProperty": "New custom value",
        "newCustomProp": "Another custom prop"
    }'

# Example response

{
    "id": "631f268442d8290001e1eee8",
    "applicantId": "631f268442d8290001e1eee9",
    "data": {
        "txnId": "631f268442d8290001e1eee9_newTxn",
        "applicant": {
            "address": {
                "country": "DEU",
                "street": "Chauseestr. 60",
                "postCode": "101115",
                "town": "Berlin"
            },
            "device": {
                "ipInfo": {
                    "ip": "87.141.63.130"
                }
            },
            "institutionInfo": {
                "code": "DEUTDEDB101",
                "name": "Deutsche Bank"
            }
        },
        "counterparty": {
            "fullName": "John Smith",
            "type": "individual",
            "institutionInfo": {
                "code": "CRESCHZZXXX",
                "name": "Credit Swiss (Schweiz)"
            }
        },
        "info": {
            "direction": "out",
            "amount": 10100.42,
            "currencyCode": "GBP",
            "paymentDetails": "Birthday Present"
        },
        "props": {
            "customProperty": "New custom value",
            "newCustomProp": "Another custom prop"
        }
    },
    "review": {
      "reviewStatus": "onHold"
    },
    "scoringResult": {
      "matchedRules": [
        {
          "id": "6391b0d1ac5401000190cf02",
          "name": "PAAM2",
          "title": "Large amount",
          "score": 30,
          "action": "onHold"
        },
        {
          "id": "6391b0b2d8f0730001bea772",
          "name": "PATX15",
          "title": "Average amount for the same beneficiary for the last month is greater by 35% of average amount for last 3 months",
          "score": 5,
          "action": "score"
        }
      ],
      "action": "onHold"
  }
}

# Re-scoring transaction

In case transaction data or rules were changed you can run re-scoring for a particular transaction with method below.

POST /resources/kyt/txns/{id}/-/score

# REQUEST ARGUMENTS

# Example request

curl -X POST \
  'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/-/score'

Response represents a full transaction data. Same as for transaction creation.

# Approve and reject transaction

POST /resources/kyt/txns/{id}/review/status/completed

# REQUEST ARGUMENTS

# Example request for approval

curl -X POST \
  'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/review/status/completed' \
  -H 'Content-Type: application/json' \
  -d '{
        "reviewAnswer": "GREEN"
    }'

# Example request for rejection

curl -X POST \
  'https://api.sumsub.com/resources/kyt/txns/631f268442d8290001e1eee8/review/status/completed' \
  -H 'Content-Type: application/json' \
  -d '{
        "reviewAnswer": "RED",
        "reviewRejectType": "FINAL"
    }'

Response represents a full transaction data. Same as for transaction creation.

# Webhooks

On the KYT request stats change, we send different types of webhooks depending on the transaction status.

# Webhook payload attributes

# Example applicantKytTxnApproved webhook payload

{
  "applicantId": "634829375766b80001a40152",
  "applicantType": "individual",
  "correlationId": "f24f6616020245053139a6537303a251",
  "sandboxMode": false,
  "externalUserId": "customExternalUserId",
  "type": "applicantKytTxnApproved",
  "reviewResult": {
    "reviewAnswer": "GREEN"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2022-10-24 12:42:07.143",
  "clientId": "coolClientId",
  "kytTxnId": "64a7dc05fbf57c624afcb72d",
  "kytDataTxnId": "uauu08x44xexbohyh4lkp9"
}

# Example applicantKytOnHold webhook payload

{
  "applicantId": "634829375766b80001a40152",
  "applicantType": "individual",
  "correlationId": "98d4dac61c977c1b3f81d6ab78d29c3c",
  "sandboxMode": false,
  "externalUserId": "customExternalUserId",
  "type": "applicantKytOnHold",
  "reviewStatus": "onHold",
  "createdAtMs": "2022-10-24 12:44:32.341",
  "clientId": "coolClientId",
  "kytTxnId": "64a7dc05fbf57c624afcb72d",
  "kytDataTxnId": "j8bqz29yn491vksi9qfydw"
}

# Example applicantKytTxnRejected webhook payload

{
  "applicantId": "634829375766b80001a40152",
  "applicantType": "individual",
  "correlationId": "0f5a7c828bab750775564534fc0470a8",
  "sandboxMode": false,
  "externalUserId": "customExternalUserId",
  "type": "applicantKytTxnRejected",
  "reviewResult": {
    "reviewAnswer": "RED",
    "reviewRejectType": "FINAL"
  },
  "reviewStatus": "completed",
  "createdAtMs": "2022-10-24 12:45:04.982",
  "clientId": "coolClientId",
  "kytTxnId": "64a7dc05fbf57c624afcb72d",
  "kytDataTxnId": "j8bqz29yn491vksi9qfydw"
}

# FAQ

# What should we do if we don't have a checked applicant to add a transaction to it?

If you'd like to create a transaction for a user that hasn't passed verification via our service yet, you can create a new applicant and add a transaction to it using single request POST /resources/applicants/-/kyt/txns/-/data?levelName={levelName}. More info is in documentation above.

# What happens to a transaction when it is added?

It is saved and then scored. Depending on the matched rules, the transaction may end up in the “approved”, “rejected” or “on hold” state. Also, it may affect an applicant by requesting additional verifications.

# How can I apply different rules to transactions from different sources?

Provide the sourceKey field in the transaction data when creating it. Rules without a source key, or source keys that include the transaction source key will be applied.

# How can I get notified about the scoring result?

You can set up webhooks the same way you do for the applicants. You can react on approved, rejected, and “on hold” transactions.

# How can I test a new rule without fear of breaking anything?

When installing a rule, it is in the Dry run mode by default, meaning that it will be applied but will not affect the final scoring. Additionally, on the Rules tab, you can test the rule by applying it to existing transactions retrospectively.

# What do I do with transactions that are put on hold?

You can explore them at My queues tab and make a final decision. Or you may decide to request an additional applicant action that you set up in advance, e.g. a liveness check, source of funds request, or a questionnaire. So when the applicant action is complete, the status of the transaction will change accordingly. Thus, you can automate risky or suspicious transactions.

# What if I want to have rules that are based on some custom data that are not in your data model?

Add custom fields into the props map in the transaction data. We will be able to set up rules based on them.

# What can I base my rules on?

Pretty much on everything that we collected about the applicant or transaction. For example, applicant data, id docs, questionnaires, aggregations of data based on devices, geolocation, transaction amounts, and so on. If you miss anything, get in touch. In most cases, it would be an easy exercise to add it for you.

# Can I control certain transactions that match certain rules?

You can set up a custom queue based on rules and computed transaction status. Then you can review transactions that appear in such custom queues, take immediate actions, assign them to yourself or other colleagues for further investigation or confirm the resulting status (if it was approved or rejected).

# What do I need to pass to stay protected?

In general, as much information as you can map to our data structure, plus put the rest into custom properties if you think this field is important. Even if you do not have rules that work on certain fields, you may have some in the future. Then you can do a re-scoring in case you decide to add more rules.

# What kind of reporting do you have?

You can get the events that happened to a transaction, plus you can get the transactions in the CSV report or a detailed PDF report about a particular transaction. If you miss some reporting feature, contact us, and we will try to satisfy your request.

# How do I get reports on certain users or transactions of interest?

Set up a filter that matches your criteria and get a CSV export. If you miss some filters contact us, we will add them for you.