post https://api.sumsub.com/resources/applicants//kyt/txns/-/data
Initiates transaction processing for existing applicants.
Overview
Use this method to process transactions for existing applicants.
Note
If you do not have a particular applicant, use Submit transaction for non-existing applicant.
Request examples
Learn more about these examples.
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"
}
},
"counterparty": {
"externalUserId": "uniqueBeneficiaryId",
"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"
}
}'
curl -X POST \
'https://api.sumsub.com/resources/applicants/631f268442d8290001e1eee9/kyt/txns/-/data' \
-H 'Content-Type: application/json' \
-d '{
"sourceKey":"DemoCryptoTxn",
"applicant":{
"paymentMethod":{
"type":"crypto",
"accountId":"19jUgPvUdSLZyuJyaydcaTcbLYPgFuxoFb"
},
"device":{
"fingerprint":"kqtyt7c0l",
"ipInfo":{
"ip":"87.141.63.130"
}
}
},
"counterparty":{
"externalUserId":"shol1mq8xipghssepfhdht",
"fullName":"Jack Posek",
"type":"individual",
"paymentMethod":{
"type":"crypto"
}
},
"info":{
"direction":"in",
"amount":2,
"currencyCode":"BTC",
"paymentTxnId":"84bf83c10dfddc9d1f0ea6a1a131c638488fb161e819dae25fd8128c671d2d5a",
"paymentDetails":"Birthday Present"
},
"props":{
"customProperty":"Custom value that can be used in rules",
"dailyOutLimit":10000
},
"txnId":"kkw5mbtuozdwn13qrf9fj",
"txnDate":"2023-09-19 14:19:06+0300"
}'
Response explained
The response contains information on the created transaction with the data object and additional objects holding the current review and scoring transaction state.
| Name | Type | Optional | Description |
|---|---|---|---|
id | String | No | A unique transaction identification number. |
applicantId | String | No | A unique applicant identification number. |
score | Integer | Yes | Transaction review scoring. |
data | Object | No | Transaction data sent previously. |
review | Object | No | Transaction review result. |
scoringResult | Object | Yes | Detailed information on transaction scoring. |
review attributes
review attributes| Name | Type | Optional | Description |
|---|---|---|---|
reviewStatus | String | No | Transaction status ( onHold, completed, init). |
reviewResult | Object | Yes | Object representing the transaction review result. |
reviewResult.reviewAnswer | String | Yes | GREEN (approved), RED (rejected). |
scoringResult attributes
scoringResult attributes| Name | Type | Optional | Description |
|---|---|---|---|
matchedRules | Array of Objects | Yes | List of matched rules. |
action | String | No | Result of all matched rules combined (score/onHold/reject). |
matchedRules attributes
matchedRules attributes| Name | Type | Optional | Description |
|---|---|---|---|
id | String | No | Rule ID. |
name | String | Yes | Rule name. |
title | String | Yes | Rule title. |
score | Integer | Yes | Amount that will be added to the overall score if the rule matches. |
action | String | No | Result action of the matched rule (score/onHold/reject). |