Submit transactions for non-existing applicant

Submits transactions for monitoring and creates a new applicant.

Overview

This method works in the same way as Submit transactions, but intended for cases where you do not have an applicant with externalUserId.

When using this method, a new applicant will be created automatically based on the provided levelName and the data taken from the applicant object.

Request examples

The following are request examples per transaction type that you can use for references to populate the constructor above and submit the request.

{ "txnId": "general0001", // Required. A unique transaction identification number. "txnDate": "2024-04-29 02:30:12+0000", // The date and time of performing a transaction. "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "000000", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // A latitude value in decimal degrees. "lon": " 1.7976931348623157", // A longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about an applicant's device location. "ip": "242.1.1" // An applicant's device IP address. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "fingerprint": "usersDeviceFing", // A device fingerprint. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "Mobile" // A platform of the device used during an online session. }, "externalUserId": "PlatformEvent0001", // Required. A unique identifier of the transaction's participant in your system. "fullName": "Users Fullname" // Required. The full name of the transaction's participant. }, "type": "userPlatformEvent", //Required. A transaction type. "userPlatformEventInfo": { // Required object. Information about an event which is made within a transaction. "type": "general", // Required. A type of an event which is made within a transaction. "failure": true // A result received within an event, where 'true' stands for 'completed', false — 'not completed'. } }
{ "txnId": "twoFaReset0001", // Required. A unique transaction identification number. "txnDate": "2024-04-29 02:30:12+0000", // The date and time of performing a transaction. "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "000000", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // A latitude value in decimal degrees. "lon": " 1.7976931348623157", // A longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about an applicant's device location. "ip": "242.1.1" // An applicant's device IP address. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "fingerprint": "usersDeviceFing", // A device fingerprint. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "Mobile" // A platform of the device used during an online session. }, "externalUserId": "PlatformEvent0001", // Required. A unique identifier of the transaction's participant in your system. "fullName": "Users Fullname" // Required. The full name of the transaction's participant. }, "type": "userPlatformEvent", // Required. A transaction type. "userPlatformEventInfo": { // Required object. Information about an event which is made within a transaction. "type": "twoFaReset", // Required object. A type of an event which is made within a transaction. "failure": true // A result received within an event, where 'true' stands for 'completed', false — 'not completed'. } }
{ "txnId": "passwordReset0001", // Required. A unique transaction identification number. "txnDate": "2024-04-29 02:30:12+0000", // The date and time of performing a transaction. "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "000000", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // A latitude value in decimal degrees. "lon": " 1.7976931348623157", // A longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about an applicant's device location. "ip": "242.1.1" // An applicant's device IP address. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "fingerprint": "usersDeviceFing", // A device fingerprint. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "Mobile" // A platform of the device used during an online session. }, "externalUserId": "PlatformEvent0001", // Required. A unique identifier of the transaction's participant in your system. "fullName": "Users Fullname" // Required. The full name of the transaction's participant }, "type": "userPlatformEvent", // Required. A transaction type. "userPlatformEventInfo": { // Required object. Information about an event which is made within a transaction. "type": "passwordReset", // Required. A type of an event which is made within a transaction. "failure": true // A result received within an event, where 'true' stands for 'completed', false — 'not completed'. } }
{ "txnId": "login0001", // Required. A unique transaction identification number. "txnDate": "2024-04-29 02:30:12+0000", // The date and time of performing a transaction. "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "000000", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // A latitude value in decimal degrees. "lon": " 1.7976931348623157", // A longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about an applicant's device location. "ip": "242.1.1" // An applicant's device IP address. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "fingerprint": "usersDeviceFing", // A device fingerprint. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "Mobile" // A platform of the device used during an online session. }, "externalUserId": "PlatformEvent0001", // Required. A unique identifier of the transaction's participant in your system. "fullName": "Users Fullname" // Required. The full name of the transaction's participant. }, "type": "userPlatformEvent", // Required. A transaction type. "userPlatformEventInfo": { // Required object. Information about an event which is made within a transaction. "type": "login", // Required. A type of an event which is made within a transaction. "failure": true // A result received within an event, where 'true' stands for 'completed', false — 'not completed'. } }
{ "txnId": "SingUp0001", // Required. A unique transaction identification number. "txnDate": "2024-04-29 02:30:12+0000", // The date and time of performing a transaction. "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "000000", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // A latitude value in decimal degrees. "lon": " 1.7976931348623157", // A longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about an applicant's device location. "ip": "242.1.1" // An applicant's device IP address. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "fingerprint": "usersDeviceFing", // A device fingerprint. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "Mobile" // A platform of the device used during an online session. }, "externalUserId": "PlatformEvent0001", // Required. A unique identifier of the transaction's participant in your system. "fullName": "Users Fullname" // Required. The full name of the transaction's participant. }, "type": "userPlatformEvent", // Required. A transaction type. "userPlatformEventInfo": { // Required object. Information about an event which is made within a transaction. "type": "signup", // Required. A type of an event which is made within a transaction. "failure": true // A result received within an event, where 'true' stands for 'completed', false — 'not completed'. } }
{ "info": { // Required object. General information about a transaction. "direction": "out", // Required. A direction of your transaction —'in' for a deposit, 'out' for withdrawal. "amount": 10, // Required. An amount of deposit or withdrawal. "currencyCode": "STG", // Required. A code of currency in which a transaction is made. "currencyType": "crypto", // A type of currency used during a transaction. "paymentDetails": "InfoDetails", // A text written by the user within a transaction. "paymentTxnId": "txnHash", // Required for a crypto check. A unique identifier that is used to monitor a transaction on the blockchain. "type": "customType", // A string for categorizing transactions (e.g. for gambling — payroll, bonus, etc.). "cryptoParams": { // Includes crypto transaction parameters. "cryptoChain": "ETH" // Optional, only needed when the asset is on a non-native chain. } }, "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "Crypto0001", // Required. A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PRT" // A transaction institution's country. }, "code": "InstCode", // A transaction institution's code. "name": "InstName" // A transaction institution's name. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "crypto", // A payment method type. "accountId": "usersWalletAddress", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "mobile", // A platform of the device used during an online session. "fingerprint": "usersDeviceFing" // A device fingerprint. }, "fullName": "Users Fullname" // Required. The full name of the transaction's participant (an applicant or counterparty). }, "counterparty": { // Required object for a crypto check. Information about a sender/receiver depending on the transaction's direction. "type": "individual", // A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the counterparty's address. "country": "QAT", // A participant's country per ISO 3166. "postCode": "444444", // A participant's address postcode. "town": "cpTown", // A participant's address town. "street": "cpSt", // A participant's address street. "subStreet": "cpSbSt", // A participant's address sub street. "state": "cpState", // A participant's address state. "flatNumber": "10", // A participant's address flat number. "buildingNumber": "10" // A participant's address building number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PAN" // A transaction institution's country. }, "code": "cpInstCode", // A transaction institution's code. "name": "cpInstName" // A transaction institution's name. }, "paymentMethod": { // Required object for a crypto check. Information about the payment method used within a transaction. "type": "crypto", // A payment method type. "accountId": "cpWalletAddress", // Required for a crypto check. "issuingCountry": "SVN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about a counterparty's device. "ipInfo": { // Information about a counterparty's device location. "lat": 600, // A latitude value in decimal degrees. "lon": 700, // A longitude value in decimal degrees. "ip": "62.228.108.249", // A counterparty's IP address. "countryCode3": "SJM" // A country of the device's location per ISO 3166. }, "userAgent": "cpDevUA", // Information about a counterparty's online session. "sessionId": "cpDevSess", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "cpDevPlat", // A platform of the device used during an online session. "fingerprint": "cpDevFing" // A device fingerprint. }, "externalUserId": "cpExtId", // A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "fullName": "CP Name" // The full name of the transaction's participant (an applicant or counterparty). }, "type": "finance", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "txnDate": "2024-04-04 13:50:00+0300", // The date and time of performing a transaction. "txnId": "crypto0001" // Required. A unique transaction identification number. }
{ "info": { // Required object. General information about a transaction. "direction": "in", // Required. A direction of your transaction —'in' for a deposit, 'out' for withdrawal. "amount": 10, // Required. An amount of deposit or withdrawal. "currencyCode": "STG", // Required. A code of currency in which a transaction is made. "currencyType": "crypto", // A type of currency used during a transaction. "paymentDetails": "InfoDetails", // A text written by the user within a transaction. "paymentTxnId": "txnHash", // Required for a crypto check. A unique identifier that is used to monitor a transaction on the blockchain. "type": "customType" // A string for categorizing transactions (e.g. for gambling — payroll, bonus, etc.). "cryptoParams": { // Includes crypto transaction parameters. "cryptoChain": "ETH" // Optional, only needed when the asset is on a non-native chain. } }, "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "Crypto0001", // Required. A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PRT" // A transaction institution's country. }, "code": "InstCode", // A transaction institution's code. "name": "InstName" // A transaction institution's name. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "crypto", // A payment method type. "accountId": "usersWalletAddress", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "mobile", // A platform of the device used during an online session. "fingerprint": "usersDeviceFing" // A device fingerprint. }, "fullName": "Users Fullname" // Required. The full name of the transaction's participant (an applicant or counterparty). }, "counterparty": { // Required object for a crypto check. Information about a sender/receiver depending on the transaction's direction. "type": "individual", // A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the counterparty's address. "country": "QAT", // A participant's country per ISO 3166. "postCode": "444444", // A participant's address postcode. "town": "cpTown", // A participant's address town. "street": "cpSt", // A participant's address street. "subStreet": "cpSbSt", // A participant's address sub street. "state": "cpState", // A participant's address state. "flatNumber": "10", // A participant's address flat number. "buildingNumber": "10" // A participant's address building number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PAN" // A transaction institution's country. }, "code": "cpInstCode", // A transaction institution's code. "name": "cpInstName" // A transaction institution's name. }, "paymentMethod": { // Required object for a crypto check. Information about the payment method used within a transaction. "type": "crypto", // A payment method type. "accountId": "cpWalletAddress", // Required for a crypto check. "issuingCountry": "SVN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about a counterparty's device. "ipInfo": { // Information about a counterparty's device location. "lat": 600, // A latitude value in decimal degrees. "lon": 700, // A longitude value in decimal degrees. "ip": "62.228.108.249", // A counterparty's IP address. "countryCode3": "SJM" // A country of the device's location per ISO 3166. }, "userAgent": "cpDevUA", // Information about a counterparty's online session. "sessionId": "cpDevSess", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "cpDevPlat", // A platform of the device used during an online session. "fingerprint": "cpDevFing" // A device fingerprint. }, "externalUserId": "cpExtId", // A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "fullName": "CP Name" // The full name of the transaction's participant (an applicant or counterparty). }, "type": "finance", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "txnDate": "2024-04-04 13:50:00+0300", // The date and time of performing a transaction. "txnId": "crypto0001" // Required. A unique transaction identification number. }
{ "info": { // Required object. General information about a transaction. "direction": "out", // Required. A direction of your transaction —'in' for a deposit, 'out' for withdrawal. "amount": 1000, // Required. An amount of deposit or withdrawal. "currencyCode": "EUR", // Required. A code of currency in which a transaction is made. "currencyType": "fiat", // A type of currency used during a transaction. "paymentDetails": "InfoDetails", // A text written by the user within a transaction. "type": "CustomTxnType" // A string for categorizing transactions (e.g. for gambling — payroll, bonus, etc.). }, "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "Finance0001", // Required. A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PRT" // A transaction institution's country. }, "code": "InstCode", // A transaction institution's code. "name": "InstName" // A transaction institution's name. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "card", // A payment method type. "accountId": "usersWalletAddress", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "mobile", // A platform of the device used during an online session. "fingerprint": "usersDeviceFing" // A device fingerprint. }, "fullName": "Users Fullname" // Required. The full name of the transaction's participant (an applicant or counterparty). }, "counterparty": { // Information about a sender/receiver depending on the transaction's direction. "type": "individual", // A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the counterparty's address. "country": "QAT", // A participant's country per ISO 3166. "postCode": "444444", // A participant's address postcode. "town": "cpTown", // A participant's address town. "street": "cpSt", // A participant's address street. "subStreet": "cpSbSt", // A participant's address sub street. "state": "cpState", // A participant's address state. "flatNumber": "10", // A participant's address flat number. "buildingNumber": "10" // A participant's address building number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PAN" // A transaction institution's country. }, "code": "cpInstCode", // A transaction institution's code. "name": "cpInstName" // A transaction institution's name. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "cpPayType", // A payment method type. "accountId": "cpPayAccId", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about a counterparty's device. "ipInfo": { // Information about a counterparty's device location. "lat": 600, // A latitude value in decimal degrees. "lon": 700, // A longitude value in decimal degrees. "ip": "192.2.2", // A counterparty's IP address. "countryCode3": "SJM" // A country of the device's location per ISO 3166. }, "userAgent": "cpDevUA", // Information about a counterparty's online session. "sessionId": "cpDevSess", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "cpDevPlat", // A platform of the device used during an online session. "fingerprint": "cpDevFing" // A device fingerprint. }, "externalUserId": "cpExtId", // A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "fullName": "CP Name" // The full name of the transaction's participant (an applicant or counterparty). }, "type": "finance", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "txnDate": "2024-04-04 13:50:00+0300", // The date and time of performing a transaction. "txnId": "finance0001" // Required. A unique transaction identification number. }
{ "info": { // Required object. General information about a transaction. "direction": "in", // Required. A direction of your transaction —'in' for a deposit, 'out' for withdrawal. "amount": 1000, // Required. An amount of deposit or withdrawal. "currencyCode": "EUR", // Required. A code of currency in which a transaction is made. "currencyType": "fiat", // A type of currency used during a transaction. "paymentDetails": "InfoDetails", // A text written by the user within a transaction. "type": "CustomTxnType" // A string for categorizing transactions (e.g. for gambling — payroll, bonus, etc.). }, "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "Finance0001", // Required. A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PRT" // A transaction institution's country. }, "code": "InstCode", // A transaction institution's code. "name": "InstName" // A transaction institution's name. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "card", // A payment method type. "accountId": "usersWalletAddress", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "mobile", // A platform of the device used during an online session. "fingerprint": "usersDeviceFing" // A device fingerprint. }, "fullName": "Users Fullname" // Required. The full name of the transaction's participant (an applicant or counterparty). }, "counterparty": { // Information about a sender/receiver depending on the transaction's direction. "type": "individual", // A participant entity type—company or individual. The ‘individual’ is set by default. "address": { // Information about the counterparty's address. "country": "QAT", // A participant's country per ISO 3166. "postCode": "444444", // A participant's address postcode. "town": "cpTown", // A participant's address town. "street": "cpSt", // A participant's address street. "subStreet": "cpSbSt", // A participant's address sub street. "state": "cpState", // A participant's address state. "flatNumber": "10", // A participant's address flat number. "buildingNumber": "10" // A participant's address building number. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "address": { // A transaction institution's address. "country": "PAN" // A transaction institution's country. }, "code": "cpInstCode", // A transaction institution's code. "name": "cpInstName" // A transaction institution's name. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "cpPayType", // A payment method type. "accountId": "cpPayAccId", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about a counterparty's device. "ipInfo": { // Information about a counterparty's device location. "lat": 600, // A latitude value in decimal degrees. "lon": 700, // A longitude value in decimal degrees. "ip": "192.2.2", // A counterparty's IP address. "countryCode3": "SJM" // A country of the device's location per ISO 3166. }, "userAgent": "cpDevUA", // Information about a counterparty's online session. "sessionId": "cpDevSess", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "cpDevPlat", // A platform of the device used during an online session. "fingerprint": "cpDevFing" // A device fingerprint. }, "externalUserId": "cpExtId", // A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "fullName": "CP Name" // The full name of the transaction's participant (an applicant or counterparty). }, "type": "finance", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "txnDate": "2024-04-04 13:50:00+0300", // The date and time of performing a transaction. "txnId": "finance0001" // Required. A unique transaction identification number. }
{ "gamblingBetInfo": { // Required object. General information about a bet. "amount": 500, // Required. An amount of a gambling bet. "currencyType": "fiat", // A currency in which a bet is made. "currencyCode": "EUR", // Required. A bet’s currency code per ISO 4217. "resultAmount": 1000, // A betting result amount (e.g, an applicant wins 1000 EUR). "betType": "yourTypesOfBetsHere", // A type of gambling bet. "gameType": "yourTypesOfGamesHere", // A type of the game for which the bet is made. "bonusId": "bonusId" // A unique identifier indicating whether a bet is made with bonus funds. If empty, it's made with deposit. }, "applicant": { // Required object. Information about the applicant placing a bet. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "BET0001", // Required. A unique identifier of the applicant placing a bet in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "mobile", // A platform of the device used during an online session. "fingerprint": "usersDeviceFing" // A device fingerprint. }, "fullName": "Users Fullname" // Required. The full name of the applicant placing a bet. }, "type": "gamblingBet", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "txnDate": "2024-04-04 13:50:00+0300", // The date and time of performing a transaction. "txnId": "BET0001" // Required. A unique transaction identification number. }
{ "gamblingBonusChangeInfo": { // Required object. Information about a gambling bonus change. "bonusId": "bonusId", // A unique identifier indicating whether a bet is made with bonus funds. If empty, it's made with deposit funds. "amount": 100, // An amount of a gambling bet. "maxBonusAmount": 200, // A maximum amount of bonus that can be received by a player. "maxBetAmount": 5, // A maximum bet allowed for a player. "wagerRequirement": 4000, // A total amount of bets that a player should place to get bonus funds to his real balance. "status": "activated" // Required. A status of change (activated/canceled/lost/finished/expired). }, "applicant": { // Required object. Information about the applicant placing a bet. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "BET0001", // Required. A unique identifier of the applicant placing a bet in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "usersAddressTown", // An applicant’s address town. "street": "usersAddSt", // An applicant’s address street. "subStreet": "usersAddSbSt", // An applicant’s address sub street. "state": "usersAddState", // An applicant’s address state. "buildingNumber": "usersAddBuildNum", // An applicant address’s building number. "flatNumber": "usersAddFlatNumber" // An applicant’s address flat number. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "usersDeviceUA", // Information about the applicant's online session. "sessionId": "usersDeviceSesId", // A transaction session identifier. "sessionAgeMs": 18, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "mobile", // A platform of the device used during an online session. "fingerprint": "usersDeviceFing" // A device fingerprint. }, "fullName": "Users Fullname" // Required. The full name of the applicant placing a bet. }, "type": "gamblingBonusChange", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "txnDate": "2024-04-04 13:50:00+0300", // The date and time of performing a transaction. "txnId": "BET0001" // Required. A unique transaction identification number. }
{ "txnId": "TravelRuleTest0007", // Required. A unique transaction identification number. "type": "travelRule", // Required. A transaction's type (finance, gamblingBet, kyc, travelRule, etc). "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "fullName": "TravelRule Person", // The full name of the transaction's participant. "externalUserId": "IdFromYourSystem0001", // Required. A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "address": { // Information about the transaction's participant address. "country": "CAN", // An applicant's country code per ISO 3166. "postCode": "111111", // An applicant’s address post code. "town": "appTown", // An applicant’s address town. "street": "appSt", // An applicant’s address street. "subStreet": "appSbSt", // An applicant’s address sub street. "state": "appState", // An applicant’s address state. "buildingNumber": "10", // An applicant address’s building number. "flatNumber": "10" // An applicant’s address flat number. }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "account", // A payment method type. "accountId": "UsersWalletAddress0001", // A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about an applicant’s device. "ipInfo": { // Information about an applicant's device location. "lat": 300, // A latitude value in decimal degrees. "lon": 500, // A longitude value in decimal degrees. "ip": "178.123.68.138", // An applicant's device IP address. "countryCode3": "POL" // A country of the device's location per ISO 3166. }, "userAgent": "AppDevUA", // Information about the applicant's online session. "sessionId": "AppDevSessId", // A transaction session identifier. "sessionAgeMs": 100, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "AppDevPlatfrom", // A platform of the device used during an online session. "fingerprint": "AppDevFing" // A device fingerprint. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction. "internalId": "661d150d075ac53ae9129258" // Required. VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. } }, "counterparty": { // Required object. Information about a sender/receiver depending on the transaction's direction. "type": "individual", // Required. A participant entity type—company or individual. The ‘individual’ is set by default. "fullName": "Reciever's FullName", // Required. The full name of the transaction's participant. "externalUserId": "wru1tc63m0jhctaoejboim", // Required. A unique identifier of the transaction's participant (an applicant or counterparty) in your system. "address": { // Information about the counterparty's address. "country": "QAT", // A participant's country per ISO 3166. "postCode": "444444", // A participant's address postcode. "town": "cpTown", // A participant's address town. "street": "cpSt", // A participant's address street. "subStreet": "cpSbSt", // A participant's address sub street. "state": "cpState", // A participant's address state. "flatNumber": "17", // A participant's address flat number. "buildingNumber": "17" // A participant's address building number. }, "paymentMethod": { // Required object. Information about the payment method used within a transaction. "type": "account", // Information about the payment method used within a transaction. "accountId": "RecieverWalletAddress0001", // Required. A unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // A code of the country issued the payment method per ISO 3166. }, "device": { // Information about a counterparty's device. "ipInfo": { // Information about a counterparty's device location. "lat": 600, // A latitude value in decimal degrees. "lon": 700, // A longitude value in decimal degrees. "ip": "192.2.2", // A counterparty's IP address. "countryCode3": "SJM" // A country of the device's location per ISO 3166. }, "userAgent": "cpDevUA", // A country of the device's location per ISO 3166. "sessionId": "cpDevSess", // A transaction session identifier. "sessionAgeMs": 100, // A session lifetime in milliseconds. "acceptLang": "en", // A language used during an online session (e.g eng). "platform": "cpDevPlat", // A platform of the device used during an online session. "fingerprint": "cpDevFing" // A device fingerprint. }, "institutionInfo": { // Required object. Information about the financial institution engaged in performing this transaction. "internalId": "661d1525075ac53ae9129263" // Required. VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. } }, "info": { // Required object. General information about a transaction. "direction": "in", // Required. A direction of your transaction —'in' for a deposit, 'out' for withdrawal. "amount": 10, // Required. An amount of deposit or withdrawal. "currencyCode": "STG", // Required. A code of currency in which a transaction is made. "type": "ExampleCategory", // A string for categorizing transactions (e.g. for gambling — payroll, bonus, etc.). "cryptoParams": { // Includes crypto transaction parameters. "cryptoChain": "ETH" // Optional, only needed when the asset is on a non-native chain. }, "paymentTxnId": "ExampleHash" // Required for a crypto check. A unique identifier that is used to monitor a transaction on the blockchain. }, "props": { // Custom properties. "customProperty": "Custom value that can be used in rules", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. }, "txnDate": "2024-04-25 15:08:51+0300" // The date and time of performing a transaction. }

Errors explained

The following are typical error responses that you may encounter when sending a malformed requests.

{
  "type": "net.researchgate.restdsl.exceptions.RestDslException",
  "description": "Entity already exists",
  "code": 409
}

A transaction with the related txnId already exists. Change it to unique.

{
  "type": "com.fasterxml.jackson.databind.exc.InvalidFormatException",
  "description": "Malformed data provided in the request",
  "code": 400
}
  • Check if all required parameters are in place.
  • Check the object structure and make sure that all , and {} symbols are in place.
{
      "type": "de.smtdp.commons.service.exceptions.ServiceException",
      "description": "de.smtdp.commons.service.exceptions.ServiceException:When no applicant id provided, applicant.externalUserId and applicant.fullName must be set",
      "code": 400
}

Provide a unique value in the externalUserId parameter and fullName in the applicant object.

CORRECT EXAMPLE:

"applicant": {  
    "type": "individual",  
    "externalUserId": "PlatformEvent0001",  
    "fullName": "User fullname"  
}
{
    "type": "io.dropwizard.jersey.validation.JerseyViolationException",
    "description": "type is not valid, must be one of: travelRule, finance, gamblingBet, gamblingLimitChange, gamblingBonusChange, kyc, auditTrailEvent, userPlatformEvent",
    "code": 400
}

Make sure to use one of the supported txn/event types.

{
  "type": "io.dropwizard.jersey.validation.JerseyViolationException",
  "description": "userPlatformEventInfo.type typo is not valid, must be one of: login, signup, passwordReset, twoFaReset, general",
  "code": 400
}

Make sure to use one of the supported event sub types.

{
  "type": "de.smtdp.commons.service.exceptions.ServiceException",
  "description": "de.smtdp.commons.service.exceptions.ServiceException:Request signature mismatch",
  "code": 401,
  "errorCode": 4003,
  "errorName": "app-token-signature mismatch"
}

Make sure to use a correct secret key for the app token that you have created in the Dashboard (Dev. Space).

{
  "type": "de.smtdp.commons.service.exceptions.ServiceException",
  "description": "de.smtdp.commons.service.exceptions.ServiceException:App token is invalid",
  "code": 401,
  "errorCode": 4002,
  "errorName": "app-token-private-part-mismatch"
}

Check the correctness of the used app token.

{
  "type": "de.smtdp.commons.service.exceptions.ServiceException",
  "description": "de.smtdp.commons.service.exceptions.ServiceException:Invalid app token format",
  "code": 401,
  "errorCode": 4000,
  "errorName": "app-token-invalid-format"
}

Make sure to create an app token and a sceret key in Dev. Space, and include them in your request.

Language
Authorization
Header
Click Try It! to start a request and see the response here!