post
https://api.sumsub.com/resources/api/tm/applicants/-/txns
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
This method is similar to standard endpoint, but the transaction data is passed in the data object, and the options object controls asynchronous scoring. The level name is passed in options.levelName and the Device Intelligence access token in options.behavioralAccessToken instead of the levelName and accessToken query parameters.
If an applicant with the provided externalUserId already exists, the transaction is attached to that applicant; levelName and applicant.type are ignored and the applicant's level is not changed. Otherwise, a new applicant profile is created automatically.
Required permissions
To use this method:
- Your app token must have the Manage TM transactions - Decisions permission.
- Your account must have Transaction Monitoring enabled in some form (for example, KYT scoring, Travel Rule, Device Intelligence, or one of the supported crypto risk-scoring providers).
Both conditions are required — missing the permission, or having no TM feature enabled, returns a 403 Forbidden. If neither feature is enabled for your account, contact your CSM or Sumsub support.
Use case
Set async: true if your integration cannot afford to wait for scoring to finish — for example, when slow external risk checks are configured, or you are submitting a high volume of transactions. The final result then arrives via webhook or a follow-up Get transaction call instead of in the response.
Request example
curl -X POST \
'https://api.sumsub.com/resources/api/tm/applicants/-/txns' \
-H 'content-type: application/json' \
-H 'X-App-Token: <your-app-token>' \
-H 'X-App-Access-Sig: <your-signature>' \
-H 'X-App-Access-Ts: <unix-timestamp>' \
-d '{
"options": {
"async": false
},
"data": {
"txnId": "finance0001",
"txnDate": "2024-04-04 13:50:00+0300",
"zoneId": "UTC+01:00",
"type": "finance",
"info": {
"direction": "out",
"amount": 1000,
"currencyCode": "EUR",
"currencyType": "fiat",
"paymentDetails": "InfoDetails",
"type": "CustomTxnType"
},
"applicant": {
"type": "individual",
"externalUserId": "Finance0001",
"fullName": "John Smith",
"fullNameEn": "John Smith",
"placeOfBirth": "settlementName",
"dob": "1995-09-30",
"address": {
"country": "CAN",
"postCode": "123456",
"town": "usersAddressTown",
"state": "usersAddState",
"street": "usersAddSt",
"subStreet": "usersAddSbSt",
"flatNumber": "101",
"buildingNumber": "202",
"buildingName": "usersAddBuildName",
"formattedAddress": "postCode, town, state, street, buildingNumber"
},
"institutionInfo": {
"address": {
"country": "PRT"
},
"code": "BIC",
"name": "Wells Fargo"
},
"paymentMethod": {
"type": "card",
"accountId": "411111******1111",
"accountIdHash": "m77xlHZiPKVsF9p1/VdzTb+CUwaGBDpuSRxtcb7+j24=",
"issuingCountry": "CAN"
},
"device": {
"ipInfo": {
"lat": 300,
"lon": 500,
"ip": "178.123.68.138",
"countryCode3": "POL"
},
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9",
"sessionId": "r-v3-812412m9e12d42",
"sessionAgeMs": 18,
"acceptLang": "en",
"fingerprint": "usersDeviceFing"
}
},
"counterparty": {
"type": "individual",
"externalUserId": "cpExtId",
"fullName": "CP Name",
"fullNameEn": "CP Fullname English",
"placeOfBirth": "settlementName",
"dob": "1995-09-30",
"address": {
"country": "QAT",
"postCode": "987654",
"town": "cpTown",
"state": "cpState",
"street": "cpStreet",
"subStreet": "cpSubStreet",
"flatNumber": "303",
"buildingNumber": "404",
"buildingName": "cpBuildingName",
"formattedAddress": "postCode, town, state, street, buildingNumber"
},
"institutionInfo": {
"address": {
"country": "PAN"
},
"code": "BIC",
"name": "Wells Fargo"
},
"paymentMethod": {
"type": "card",
"accountId": "cpPayAccId",
"issuingCountry": "SVN"
},
"device": {
"ipInfo": {
"lat": 600,
"lon": 700,
"ip": "192.2.2",
"countryCode3": "SJM"
},
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9",
"sessionId": "r-v3-812412m9e12d42",
"sessionAgeMs": 18,
"acceptLang": "en",
"fingerprint": "cpDevFing"
}
},
"props": {
"customProperty": "Custom value",
"dailyOutLimit": "10000"
}
}
}'
NoteSee Submit transaction for non-existing applicant for details and example payloads for the data object.
Response example
{
"id": "663b3883f882642c48f43af0",
"applicantId": "663b3883f882642c48f43aea",
"scope": "events",
"externalUserId": "Finance0001",
"clientId": "korban.inc",
"data": {
"txnId": "finance0001",
"txnDate": "2024-04-04 10:50:00+0000",
"type": "finance",
"info": {
"type": "CustomTxnType",
"direction": "out",
"amount": 1000,
"currencyCode": "EUR",
"currencyType": "fiat",
"amountInDefaultCurrency": 1000,
"defaultCurrencyCode": "EUR",
"paymentDetails": "InfoDetails"
},
"applicant": {
"externalUserId": "Finance0001",
"fullName": "Users Fullname",
"fullNameEn": "Users Fullname",
"dob": "1995-09-30",
"placeOfBirth": "settlementName",
"address": {
"buildingName": "usersAddBuildName",
"flatNumber": "101",
"subStreet": "usersAddSbSt",
"subStreetEn": "usersAddSbStEn",
"street": "usersAddSt",
"streetEn": "usersAddStEn",
"state": "usersAddState",
"stateEn": "usersAddStateEn",
"buildingNumber": "202",
"town": "usersAddressTown",
"townEn": "usersAddressTownEn",
"postCode": "123456",
"country": "CAN",
"formattedAddress": "postCode, town, state, street, buildingNumber"
},
"type": "individual",
"paymentMethod": {
"type": "card",
"accountId": "411111******1111",
"accountIdHash": "m77xlHZiPKVsF9p1/VdzTb+CUwaGBDpuSRxtcb7+j24=",
"issuingCountry": "CAN"
},
"paymentMethodExtractedInfo": {
"type": "smartContract"
},
"device": {
"ipInfo": {
"ip": "178.123.68.138",
"countryCode2": "PL",
"countryCode3": "POL",
"city": "Zhytkavichy",
"zipCode": "225749",
"lat": 300,
"lon": 500,
"asn": 6697,
"asnOrg": "Republican Unitary Telecommunication Enterprise Poltelecom",
"riskyAsn": false
},
"userAgent": "usersDeviceUA",
"sessionId": "usersDeviceSesId",
"sessionAgeMs": 18,
"acceptLang": "en",
"fingerprint": "usersDeviceFing"
},
"institutionInfo": {
"code": "InstCode",
"name": "InstName",
"address": {
"country": "PRT"
}
}
},
"counterparty": {
"externalUserId": "cpExtId",
"fullName": "Users Fullname",
"fullNameEn": "Users Fullname",
"dob": "1995-09-30",
"placeOfBirth": "settlementName",
"address": {
"buildingName": "cpBuildingName",
"flatNumber": "303",
"subStreet": "cpSubStreet",
"subStreetEn": "cpSubStreetEn",
"street": "cpStreet",
"streetEn": "cpStreetEn",
"state": "cpState",
"stateEn": "cpStateEn",
"buildingNumber": "404",
"town": "cpTown",
"townEn": "cpTownEn",
"postCode": "987654",
"country": "QAT",
"formattedAddress": "postCode, town, state, street, buildingNumber"
},
"type": "individual",
"paymentMethod": {
"type": "cpPayType",
"accountId": "cpPayAccId",
"issuingCountry": "SVN"
},
"paymentMethodExtractedInfo": {
"type": "smartContract"
},
"device": {
"ipInfo": {
"ip": "178.123.68.138",
"countryCode3": "SJM",
"lat": 600,
"lon": 700,
"riskyAsn": false
},
"userAgent": "cpDevUA",
"sessionId": "cpDevSess",
"sessionAgeMs": 18,
"acceptLang": "en",
"fingerprint": "cpDevFing"
},
"institutionInfo": {
"code": "cpInstCode",
"name": "cpInstName",
"address": {
"country": "PAN"
}
}
},
"props": {
"customProperty": "Custom value",
"dailyOutLimit": "10000"
}
},
"score": 0,
"review": {
"reviewId": "vlMRF",
"attemptId": "oANbQ",
"attemptCnt": 1,
"elapsedSincePendingMs": 24,
"elapsedSinceQueuedMs": 24,
"createDate": "2024-05-08 08:32:03+0000",
"reviewResult": {
"reviewAnswer": "GREEN"
},
"reviewStatus": "completed"
},
"createdAt": "2024-05-08 08:32:03+0000",
"scoringResult": {
"score": 0,
"dryScore": 0,
"matchedRules": [],
"action": "score",
"ruleCnt": 0,
"dryRunRuleCnt": 0,
"tagScores": []
},
"typedTags": [],
"txnInactive": false
}
NoteSee Submit transaction for non-existing applicant for details and example responses.