> ## Documentation Index > Fetch the complete documentation index at: https://docs.sumsub.com/llms.txt > Use this file to discover all available pages before exploring further. # Submit transaction # Overview Use this method to submit transactions for risk monitoring and scoring. For implementation guidance, refer to the [integration flow diagram](https://docs.sumsub.com/sumsub/docs/submit-transactions-and-review-results#default-tm-integration-flow). > 🚧 Attention > > Mandatory fields in the request are determined by the transaction type. Refer to the [request examples](#request-examples) below for specific field requirements associated with each type. > 📘 Notes > > * For more information about the default TM integration flow, refer to [this page](https://docs.sumsub.com/sumsub/docs/submit-transactions-and-review-results#default-tm-integration-flow). > * To submit transactions for non-existing applicants, refer to [this page](https://docs.sumsub.com/sumsub/reference/submit-transaction-for-non-existing-applicant). ## Try API with Postman You can experiment with the API using Postman. Use [this collection](https://github.com/SumSubstance/TMandTRPostmanCollection/archive/refs/heads/main.zip) , which is specifically prepared for **Transaction Monitoring** and **Travel Rule**. # Request examples The following are the examples of request bodies per transaction type that you can use for references to populate the constructor above and submit the request. [block:html] { "html": "
\n \n \n
" } [/block] ```json { "txnId": "finance0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-04 13:50:00+0300", // Date and time of performing the transaction. "zoneId": "UTC+01:00", // Time zone identifier. "type": "finance", // Required. Transaction type (finance, kyc, travelRule, etc). "info": { // Required object. General information about the transaction. "direction": "out", // Required. Direction of your transaction —'in' for deposit, 'out' for withdrawal. "amount": 1000, // Required. Amount of deposit or withdrawal. "currencyCode": "EUR", // Required. Code of the currency in which the transaction is made. "currencyType": "fiat", // Type of currency used during the transaction. "paymentDetails": "InfoDetails", // Remittance or payment reference information. "type": "CustomTxnType" // A string for categorizing transactions. }, "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "Finance0001", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "John Smith", // Required. Full name of the transaction participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the applicant side. "address": { // Applicant institution address. "country": "PRT" // Applicant institution country. Presented in Alpha-3 code. }, "code": "BIC", // Applicant institution code (e.g. BIC). "name": "Wells Fargo" // Applicantinstitution name (e.g. Wells Fargo). }, "paymentMethod": { // Information about the payment method used within a transaction. "type": "card", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "XX00123456789012345678", // Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. Case-sensitive! "issuingCountry": "CAN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about the applicant device. "ipInfo": { // Information about the applicant device location. "lat": 300, // Latitude value in decimal degrees. "lon": 500, // Longitude value in decimal degrees. "ip": "178.123.68.138", // Applicant device IP address. "countryCode3": "POL" // Country of the device location. Presented in Alpha-3 code. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during the online session (e.g. eng). "fingerprint": "usersDeviceFing" // Device fingerprint. } }, "counterparty": { // Information about a sender/receiver depending on the transaction's direction. "type": "individual", // Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "cpExtId", // Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "CP Name", // Full name of the transaction participant (applicant or counterparty). "fullNameEn": "CP Fullname English", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the counterparty address. "country": "QAT", // Alpha-3 country code per ISO 3166. "postCode": "987654", // Address post code. "town": "cpTown", // City, town, or another settlement. "state": "cpState", // State, region, district, county or another territorial entity inside a country. "street": "cpStreet", // Street name. "subStreet": "cpSubStreet", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "303", // Flat or apartment number. "buildingNumber": "404", // Building number. "buildingName": "cpBuildingName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the counterparty side. "address": { // Counterparty institution address. "country": "PAN" // Counterparty institution country. }, "code": "BIC", // Counterparty institution code (e.g. BIC). "name": "Wells Fargo" // Counterparty institution name (e.g. Wells Fargo). }, "paymentMethod": { // Information about the payment method used within the transaction. "type": "card", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "cpPayAccId", // Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about a counterparty's device. "ipInfo": { // Information about a counterparty's device location. "lat": 600, // Latitude value in decimal degrees. "lon": 700, // Longitude value in decimal degrees. "ip": "192.2.2", // Counterparty IP address. "countryCode3": "SJM" // Country of the device location per ISO 3166. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during an online session (e.g. eng). "fingerprint": "cpDevFing" // Device fingerprint. } }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "finance0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-04 13:50:00+0300", // Date and time of performing the transaction. "zoneId": "UTC+01:00", // Time zone identifier. "type": "finance", // Required. Transaction type (finance, kyc, travelRule, etc). "info": { // Required object. General information about the transaction. "direction": "in", // Required. Direction of your transaction — 'in' for deposit, 'out' for withdrawal. "amount": 1000, // Required. Amount of deposit or withdrawal. "currencyCode": "EUR", // Required. Code of currency in which the transaction is made. "currencyType": "fiat", // Type of currency used during the transaction. "paymentDetails": "InfoDetails", // Remittance or payment reference information. "type": "CustomTxnType" // A string for categorizing transactions. }, "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "Finance0001", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "User Fullname", // Required. Full name of the transaction participant. "fullNameEn": "User Fullname English", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction participant's address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the applicant side. "address": { // Applicant institution address. "country": "PRT" // Applicant institution country. }, "code": "BIC", // Applicant institution code (e.g. BIC). "name": "Wells Fargo" // Applicant institution name (e.g. Wells Fargo). }, "paymentMethod": { // Information about the payment method used within the transaction. "type": "card", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "XX00123456789012345678", // Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. Case-sensitive! "issuingCountry": "CAN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about the applicant device. "ipInfo": { // Information about the applicant device location. "lat": 300, // Latitude value in decimal degrees. "lon": 500, // Longitude value in decimal degrees. "ip": "178.123.68.138", // Applicant device IP address. "countryCode3": "POL" // Country of the device location per ISO 3166. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during the online session (e.g eng). "fingerprint": "usersDeviceFing" // Device fingerprint. } }, "counterparty": { // Information about the sender/receiver depending on the transaction direction. "type": "individual", // Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "cpExtId", // Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "Jack Posek", // Full name of the transaction participant (applicant or counterparty). "fullNameEn": "Jack Posek", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the counterparty address. "country": "QAT", // Alpha-3 country code per ISO 3166. "postCode": "987654", // Address post code. "town": "cpTown", // City, town, or another settlement. "state": "cpState", // State, region, district, county or another territorial entity inside a country. "street": "cpStreet", // Street name. "subStreet": "cpSubStreet", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "303", // Flat or apartment number. "buildingNumber": "404", // Building number. "buildingName": "cpBuildingName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the counterparty side. "address": { // Counterparty institution address. "country": "PAN" // Counterparty institution country. }, "code": "BIC", // Counterparty institution code (e.g. BIC). "name": "Wells Fargo" // Counterparty institution name (e.g. Wells Fargo). }, "paymentMethod": { // Information about the payment method used within the transaction. "type": "card", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "cpPayAccId", // Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about the counterparty device. "ipInfo": { // Information about the counterparty device location. "lat": 600, // Latitude value in decimal degrees. "lon": 700, // Longitude value in decimal degrees. "ip": "192.2.2", // Counterparty IP address. "countryCode3": "SJM" // Country of the device location per ISO 3166. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during the online session (e.g. eng). "fingerprint": "cpDevFing" // Device fingerprint. } }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "crypto0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-04 13:50:00+0300", // Date and time of performing the transaction. "zoneId": "UTC+01:00", // Time zone identifier. "type": "finance", // Required. Transaction type (finance, kyc, travelRule, etc). "info": { // Required object. General information about the transaction. "direction": "out", // Required. Direction of your transaction — 'in' for deposit, 'out' for withdrawal. "amount": 10, // Required. Amount of deposit or withdrawal. "currencyCode": "STG", // Required. Code of currency in which the transaction is made. "currencyType": "crypto", // Type of currency used during a transaction. "paymentDetails": "InfoDetails", // Remittance or payment reference information. "paymentTxnId": "txnHash", // Unique identifier that is used to monitor a transaction on the blockchain. "type": "customType", // A string for categorizing transactions. "cryptoParams": { // Includes crypto transaction parameters. "cryptoChain": "ETH" // Optional, only needed when the asset is on a non-native chain. } }, "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "Crypto0001", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "John Smith", // Required. Full name of the transaction participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the applicant side. "address": { // Applicant institution address. "country": "PRT" // Applicant institution country. Presented in Alpha-3 code. }, "code": "BIC", // Applicant institution code (e.g. BIC). "name": "Wells Fargo" // Applicant institution name (e.g. Wells Fargo). }, "paymentMethod": { // Information about the payment method used within the transaction. "type": "crypto", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "XX00123456789012345678", // Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // Alpha-3 code (ISO 3166) of the country that issued the payment method. }, "device": { // Information about the applicant device. "ipInfo": { // Information about the applicant 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": "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during the online session (e.g. eng). "fingerprint": "usersDeviceFing" // Device fingerprint. } }, "counterparty": { // Required object for a crypto check. Information about the sender/receiver depending on the transaction direction. "type": "individual", // Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "cpExtId", // Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "Jack Posek", // Full name of the transaction participant (applicant or counterparty). "fullNameEn": "Jack Posek", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the counterparty's address. "country": "QAT", // Alpha-3 country code per ISO 3166. "postCode": "987654", // Address post code. "town": "cpTown", // City, town, or another settlement. "state": "cpState", // State, region, district, county or another territorial entity inside a country. "street": "cpStreet", // Street name. "subStreet": "cpSubStreet", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "303", // Flat or apartment number. "buildingNumber": "404", // Building number. "buildingName": "cpBuildingName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the counterparty side. "address": { // Counterparty institution address. "country": "PAN" // Counterparty institution country. Presented as Alpha-3 code. }, "code": "BIC", // Counterparty institution code (e.g. BIC). "name": "Wells Fargo", // Counterparty institution name (e.g. Wells Fargo). "internalId": "vaspInternalId" // VASP identifier for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. }, "paymentMethod": { // Required object for a crypto check. Information about the payment method used within the transaction. "type": "crypto", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "cpWalletAddress", // Required. Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about the counterparty's device. "ipInfo": { // Information about the counterparty's device location. "lat": 600, // Latitude value in decimal degrees. "lon": 700, // Longitude value in decimal degrees. "ip": "62.228.108.249", // Counterparty IP address. "countryCode3": "SJM" // Country of the device location per ISO 3166. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during the online session (e.g. eng). "fingerprint": "cpDevFing" // Device fingerprint. } }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "crypto0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-04 13:50:00+0300", // Date and time of performing the transaction. "zoneId": "UTC+01:00", // Time zone identifier. "type": "finance", // Required. Transaction type (finance, kyc, travelRule, etc). "info": { // Required object. General information about the transaction. "direction": "in", // Required. Direction of your transaction — 'in' for deposit, 'out' for withdrawal. "amount": 10, // Required. Amount of deposit or withdrawal. "currencyCode": "STG", // Required. Code of currency in which the transaction is made. "currencyType": "crypto", // Type of currency used during the transaction. "paymentDetails": "InfoDetails", // Remittance or payment reference information. "paymentTxnId": "txnHash", // Required for a crypto check. Unique identifier that is used to monitor a transaction on the blockchain. "type": "customType", // A string for categorizing transactions. "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. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "Crypto0001", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "John Smith", // Required. Full name of the transaction participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction's participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the applicant side. "address": { // Applicant institution address. "country": "PRT" // Applicant institution country. Presented in Alpha-3 code }, "code": "BIC", // Applicant institution code (e.g. BIC). "name": "Wells Fargo" // Applicant institution name (e.g. Wells Fargo). }, "paymentMethod": { // Information about the payment method used within the transaction. "type": "crypto", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "XX00123456789012345678", // Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "CAN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about the applicant device. "ipInfo": { // Information about the applicant device location. "lat": 300, // Latitude value in decimal degrees. "lon": 500, // Longitude value in decimal degrees. "ip": "178.123.68.138", // Applicant device IP address. "countryCode3": "POL" // Country of the device location. Presented in Alpha-3 code. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during an online session (e.g. eng). "fingerprint": "usersDeviceFing" // Device fingerprint. } }, "counterparty": { // Required object for a crypto check. Information about the sender/receiver depending on the transaction direction. "type": "individual", // Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "cpExtId", // Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "Jack Posek", // Full name of the transaction participant (applicant or counterparty). "fullNameEn": "Jack Posek", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the counterparty's address. "country": "QAT", // Alpha-3 country code per ISO 3166. "postCode": "987654", // Address post code. "town": "cpTown", // City, town, or another settlement. "state": "cpState", // State, region, district, county or another territorial entity inside a country. "street": "cpStreet", // Street name. "subStreet": "cpSubStreet", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "303", // Flat or apartment number. "buildingNumber": "404", // Building number. "buildingName": "cpBuildingName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "institutionInfo": { // Information about the financial institution engaged in performing this transaction on the counterparty side. "address": { // Counterparty institution address. "country": "PAN" // Counterparty institution country. Presented in Alpha-3 code. }, "code": "BIC", // Counterparty institution code (e.g. BIC). "name": "Wells Fargo", // Counterparty institution name (e.g. Wells Fargo). "internalId": "vaspInternalId" // VASP identifier for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval. }, "paymentMethod": { // Required object for a crypto check. Information about the payment method used within the transaction. "type": "crypto", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "cpWalletAddress", // Required. Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. "issuingCountry": "SVN" // Alpha-3 code of the country that issued the payment method. }, "device": { // Information about the counterparty device. "ipInfo": { // Information about the counterparty device location. "lat": 600, // Latitude value in decimal degrees. "lon": 700, // Longitude value in decimal degrees. "ip": "62.228.108.249", // Counterparty IP address. "countryCode3": "SJM" // Country of the device location per ISO 3166. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en", // Language used during an online session (e.g. eng). "fingerprint": "cpDevFing" // Device fingerprint. } }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "bgi47c04whc43ra2skg8bv", // Required. Unique transaction identifier in your system (alphanum). "zoneId": "UTC+01:00", // Time zone identifier. "type": "finance", // Required. Transaction type (finance, kyc, travelRule, etc). "info": { // Required object. General information about the transaction. "type": "withdrawal", // Transaction type. "direction": "out", // Required. Direction of your transaction — 'in' for deposit, 'out' for withdrawal. "amount": 2, // Required. Amount of deposit or withdrawal. "currencyCode": "BTC", // Required. Code of currency in which the transaction is made. "currencyType": "crypto", // Type of currency used during the transaction. "amountInDefaultCurrency": 95238.09523809524, // Transaction amount in the default currency. "defaultCurrencyCode": "EUR", // Currency code. "paymentDetails": "Birthday Present" // Remittance or payment reference information. }, "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "dash-aa5510c1-4ed4-4015-bc3c-4d916220cbaa", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "John Smith", // Required. Full name of the transaction's participant (an applicant or counterparty). "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "paymentMethod": { // Information about the payment method used within the transaction. "type": "crypto" // Payment method type, e.g. 'card', 'bank account', 'crypto'. } }, "counterparty": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "peanbpa9x4bgptzkrzr3qt", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "Jack Posek", // Required. Full name of the transaction participant (applicant or counterparty). "fullNameEn": "Jack Posek", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "paymentMethod": { // Information about the payment method used within a transaction. "type": "crypto", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "1EM4e8eu2S2RQrbS8C6aYnunWpkAwQ8GtG" // Required. Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. Case-sensitive! } }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "7hjyiypvs89ewbcv9p0ojj", // Required. Unique transaction identifier in your system (alphanum). "zoneId": "UTC+01:00", // Time zone identifier. "type": "finance", // Required. Transaction type (finance, kyc, travelRule, etc). "info": { // Required object. General information about the transaction. "paymentTxnId": "0xdd6364536f5f05cc1ea75709b676e2b1b37fad2792d3a71fb537db13100fc6b8", // Unique identifier that is used to monitor a transaction on the blockchain. "direction": "in", // Required. Direction of your transaction — 'in' for deposit, 'out' for withdrawal. "amount": 2, // Required. Amount of deposit or withdrawal. "currencyCode": "ETH", // Required. Code of the currency in which the transaction is made. "currencyType": "crypto", // Type of the currency used during the transaction. "amountInDefaultCurrency": 5720.823798627002, // Transaction amount in the default currency. "defaultCurrencyCode": "EUR", // Currency code. "paymentDetails": "Birthday Present" // Remittance or payment reference information. }, "applicant": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "dash-aa5510c1-4ed4-4015-bc3c-4d916220cbaa", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "John Smith", // Required. Full name of the transaction participant (applicant or counterparty). "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "paymentMethod": { // Information about the payment method used within the transaction. "type": "crypto", // Payment method type, e.g. 'card', 'bank account', 'crypto'. "accountId": "0x5cc17d0fa620FE99dAEAa87365C63b453BC47664" // Required. Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc. Case-sensitive! } }, "counterparty": { // Required object. Information about a participant of the transaction. "type": "individual", // Required. Participant entity type — company or individual. The ‘individual’ is set by default. "externalUserId": "peanbpa9x4bgptzkrzr3qt", // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system. "fullName": "Jack Posek", // Required. Full name of the transaction participant (applicant or counterparty). "fullNameEn": "Jack Posek", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "paymentMethod": { // Information about the payment method used within the transaction. "type": "crypto" // Payment method type, e.g. 'card', 'bank account', 'crypto'. } }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "b4xdq4qjh5qpo06r8cpunc", // Unique transaction identifier in your system. "type": "travelRule", // Must be "travelRule" for Travel Rule transactions. "counterparty": { "externalUserId": "uwccpr7tp4kjbontf", // Optional; required for aggregation-based rules. Must be consistent across transactions for the same counterparty. "nameType": "birthName", "type": "individual", // Required for all Travel Rule protocols. "dob": "1991-04-07", "placeOfBirth": "Berlin, Germany", "address": { "country": "DEU", "town": "Berlin", "postCode": "10115", "street": "Chauseestr.", "buildingNumber": "60" }, "firstName": "Jack", // Required for all Travel Rule protocols. "firstNameEn": "Jack", // Required for all Travel Rule protocols. "lastName": "Posek", // Required for all Travel Rule protocols. "lastNameEn": "Posek", // Required for all Travel Rule protocols. "idDoc": { "number": "DE42234089", "country": "DEU", "idDocType": "PASSPORT", "registrationAuthority": "BerlinMitte" }, "residenceCountry": "DEU", "paymentMethod": { "type": "crypto", // Payment method type; use "crypto" for hosted wallets or "unhostedWallet" for unhosted wallets. "accountId": "bc1q080rkmk3kj86pxvf5nkxecdrw6nrx3zzy9xl7q", // Required. Counterparty wallet address. Case-sensitive! "memo": "83927461" // Required for memo-/tag-based networks (for example, XRP, Stellar) to identify the beneficiary behind an omnibus wallet. }, "institutionInfo": { "internalId": "645a5a60294c3b043c84594f" // Optional counterparty VASP identifier; strongly recommended to improve Travel Rule success and avoid costly, less reliable attribution via analytics or address book. } }, "info": { "direction": "out", // Required. Indicates transaction direction relative to the applicant ("in" or "out"). "amount": 150.0, // Amount in the transaction currency. "amountInDefaultCurrency": 127.99, // Optional; recommended for accurate FX conversion, especially for unsupported or illiquid assets. "defaultCurrencyCode": "EUR", // Required if "amountInDefaultCurrency" is provided. "currencyCode": "USDT", // Asset code (ticker symbol). "paymentDetails": "Private transfer", "currencyType": "crypto", // Currency type; must be "crypto" for all Travel Rule transactions. "cryptoParams": { "cryptoChain": "ETH", // Required for non-native tokens to identify the blockchain. "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7" // Required to resolve ambiguity when multiple tokens share the same currency code on the same chain. } }, "props": { "dailyOutLimit": "10000", "customProperty": "Custom value that can be used in rules" }, "zoneId": "UTC+1", "txnDate": "2025-01-30 11:41:55+0000" } ``` ```json { "txnId": "2n8ezlub4n2jeua6u", // Unique transaction identifier in your system. "type": "travelRule", // Must be "travelRule" for Travel Rule transactions. "counterparty": { "externalUserId": "q5u2x5ldkio1adtjj8", // Optional but required for aggregation-based rules; must be consistent across transactions. "fullName": "Jack Posek Ltd.", // Required for all Travel Rule protocols. "fullNameEn": "Jack Posek", // Optional. Full name transliterated in English. "leiCode": "K1X8Y3F454930012", "nameType": "legalName", "type": "company", // Required. Entity type. "companyType": "limitedLiabilityCompany", "licenseNumber": "987654321", "address": { "country": "DEU", "town": "Berlin", "postCode": "10115", "street": "Chauseestr.", "buildingNumber": "60" }, "ceo": { "firstName": "Jack", // Required for all Travel Rule protocols. "firstNameEn": "Jack", // Required for all Travel Rule protocols. "lastName": "Posek", // Required for all Travel Rule protocols. "lastNameEn": "Posek", // Required for all Travel Rule protocols. "nameType": "birthName" }, "paymentMethod": { "type": "crypto", // Payment method type; use "crypto" for hosted wallets or "unhostedWallet" for unhosted wallets. "accountId": "bc1q080rkmk3kj86pxvf5nkxecdrw6nrx3zzy9xl7q" // Required. Counterparty wallet address. Case-sensitive! }, "residenceCountry": "DEU", "institutionInfo": { "internalId": "643c2b42f7bd5560a2f1c11e" // Optional counterparty VASP identifier; strongly recommended to improve Travel Rule success and avoid costly, less reliable attribution via analytics or address book. }, "registrationNumber": "DE123456789" }, "info": { "direction": "out", // Required. Indicates transaction direction relative to the applicant ("in" or "out"). "amount": 150.0, // Amount in the transaction currency. "amountInDefaultCurrency": 127.99, // Optional; recommended for accurate FX conversion, especially for unsupported or illiquid assets. "defaultCurrencyCode": "EUR", // Required if "amountInDefaultCurrency" is provided. "currencyCode": "DAI", // Asset code (ticker symbol). "paymentDetails": "Private transfer", "currencyType": "crypto", // Currency type; must be "crypto" for all Travel Rule transactions. "cryptoParams": { "cryptoChain": "ETH", // Required for non-native tokens to identify the blockchain. "contractAddress": "0x6b175474e89094c44da98b954eedeac495271d0f" // Required to resolve ambiguity when multiple tokens share the same currency code on the same chain. } }, "props": { "dailyOutLimit": "10000", "customProperty": "Custom value that can be used in rules" }, "zoneId": "UTC+1", "txnDate": "2025-12-19 15:53:00+0100" } ``` ```json { "txnId": "bhghv80bvskwne7h", // Unique transaction identifier in your system. "type": "travelRule", // Must be "travelRule" for Travel Rule transactions. "counterparty": { "externalUserId": "ee66xkf8xkrw7scepn", // Optional; required for aggregation-based rules. Must be consistent across transactions for the same counterparty. "type": "individual", // Required. Entity type. "address": { "country": "DEU", "street": "Chauseestr.", "town": "Berlin", "postCode": "10115", "buildingNumber": "60" }, "paymentMethod": { "type": "unhostedWallet", // Payment method type; use "crypto" for hosted wallets or "unhostedWallet" for unhosted wallets. "accountId": "bc1q080rkmk3kj86pxvf5nkxecdrw6nrx3zzy9xl7q" // Required. Counterparty wallet address. Case-sensitive! }, "firstName": "Jack", // Required for all Travel Rule protocols. "firstNameEn": "Jack", // Required for all Travel Rule protocols. "lastName": "Posek", // Required for all Travel Rule protocols. "lastNameEn": "Posek", // Required for all Travel Rule protocols. "nameType": "birthName", "dob": "1991-04-07", "placeOfBirth": "Berlin, Germany", "idDoc": { "number": "DE42234089", "idDocType": "PASSPORT", "country": "DEU", "registrationAuthority": "BerlinMitte" }, "residenceCountry": "DEU" }, "info": { "direction": "out", // Required. Indicates transaction direction relative to the applicant ("in" or "out"). "amount": 150.0, // Amount in the transaction currency. "amountInDefaultCurrency": 127.99, // Optional; recommended for accurate FX conversion, especially for unsupported or illiquid assets. "defaultCurrencyCode": "EUR", // Required if "amountInDefaultCurrency" is provided. "currencyCode": "USDT", // Asset code (ticker symbol). "paymentDetails": "Private transfer", // Remittance or payment reference information. "currencyType": "crypto", // Currency type; must be "crypto" for all Travel Rule transactions. "cryptoParams": { "cryptoChain": "ETH", // Required for non-native tokens to identify the blockchain. "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7" // Required to resolve ambiguity when multiple tokens share the same currency code on the same chain. } }, "props": { "dailyOutLimit": "10000", "customProperty": "Custom value that can be used in rules" }, "zoneId": "UTC+1", "txnDate": "2025-12-19 17:13:00+0100" } ``` ```json { "txnId": "2n8ezlub4n2jeua8u", // Unique transaction identifier in your system. "type": "travelRule", // Must be "travelRule" for Travel Rule transactions. "counterparty": { "externalUserId": "q5u2x5ldkio1adtjj8", // Optional; required for aggregation-based rules. Must be consistent across transactions for the same counterparty. "fullName": "Jack Posek Ltd.", // Required for all Travel Rule protocols. "fullNameEn": "Jack Posek Ltd.", // Optional. Full name transliterated in English. "leiCode": "K1X8Y3F454930012", "nameType": "legalName", "type": "company", // Required. Entity type. "companyType": "limitedLiabilityCompany", "licenseNumber": "987654321", "address": { "country": "DEU", "town": "Berlin", "postCode": "10115", "street": "Chauseestr.", "buildingNumber": "60" }, "ceo": { "firstName": "Jack", "firstNameEn": "Jack", "lastName": "Posek", "lastNameEn": "Posek", "nameType": "birthName" }, "paymentMethod": { "type": "crypto", // Payment method type; use "crypto" for hosted wallets or "unhostedWallet" for unhosted wallets. "accountId": "rDsbeomae4FXwgQTJp9Rs64Qg9vDiTCdBv", // Required. Counterparty wallet address. Case-sensitive! "memo": "83927461" // Required for memo-/tag-based networks (for example, XRP, Stellar) to identify the beneficiary behind an omnibus wallet. }, "residenceCountry": "DEU", "institutionInfo": { "internalId": "643c2b42f7bd5560a2f1c11e" // Optional counterparty VASP identifier; strongly recommended to improve Travel Rule success and avoid costly, less reliable attribution via analytics or address book. }, "registrationNumber": "DE123456789" }, "info": { "direction": "out", // Required. Indicates transaction direction relative to the applicant ("in" or "out"). "amount": 350.0, // Amount in the transaction currency. "amountInDefaultCurrency": 662.51, // Optional; recommended for accurate FX conversion, especially for unsupported or illiquid assets. "defaultCurrencyCode": "USD", // Required if "amountInDefaultCurrency" is provided. "currencyCode": "XRP", // Asset code (ticker symbol). "paymentDetails": "Private transfer", "currencyType": "crypto", // Currency type; must be "crypto" for all Travel Rule transactions. "cryptoParams": { "cryptoChain": "" // Required for non-native tokens to identify the blockchain. } }, "props": { "dailyOutLimit": "10000", "customProperty": "Custom value that can be used in rules" }, "zoneId": "UTC+1", "txnDate": "2025-12-19 15:53:00+0100" } ``` ```json { "txnId": "loi6voxz567zfu8aq9", // Unique transaction identifier in your system. "type": "travelRule", // Must be "travelRule" for Travel Rule transactions. "counterparty": { "externalUserId": "qvt79uggfq7q8newtg", // Optional; required for aggregation-based rules. Must be consistent across transactions for the same counterparty. "type": "individual", // Required. Entity type. "address": { "country": "DEU", "street": "Chauseestr.", "town": "Berlin", "postCode": "10115", "buildingNumber": "60" }, "paymentMethod": { "type": "crypto", // Payment method type; use "crypto" for hosted wallets or "unhostedWallet" for unhosted wallets. "accountId": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5" // Required. Counterparty wallet address. Case-sensitive! }, "firstName": "Jack", // Required for all Travel Rule protocols. "firstNameEn": "Jack", // Required for all Travel Rule protocols. "lastName": "Posek", // Required for all Travel Rule protocols. "lastNameEn": "Posek", // Required for all Travel Rule protocols. "nameType": "birthName", "dob": "1991-04-07", // Required for individuals when using the GTR protocol. "placeOfBirth": "Berlin, Germany", "idDoc": { "number": "DE42234089", "idDocType": "PASSPORT", "country": "DEU", "registrationAuthority": "BerlinMitte" }, "residenceCountry": "DEU", "institutionInfo": { "internalId": "65fd80a177aa675eeb9f6b71" // Optional counterparty VASP identifier; strongly recommended to improve Travel Rule success and avoid costly, less reliable attribution via analytics or address book. } }, "info": { "direction": "in", // Required. Indicates transaction direction relative to the applicant ("in" or "out"). "amount": 150.0, // Amount in the transaction currency. "amountInDefaultCurrency": 150.0, // Optional; recommended for accurate FX conversion, especially for unsupported or illiquid assets. "defaultCurrencyCode": "USD", // Required if "amountInDefaultCurrency" is provided. "currencyCode": "USDT", // Asset code (ticker symbol). "paymentDetails": "Private transfer", "currencyType": "crypto", // Currency type; must be "crypto" for all Travel Rule transactions. "cryptoParams": { "cryptoChain": "ETH", // Required for non-native tokens to identify the blockchain. "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7" // Required to resolve token ambiguity. }, "paymentTxnId": "0xd3b111a2932da3657d571e340c00ee4e4323632d9a932838f3dd02ed49c6dbd8" // Required for after on-chain transactions. }, "props": { "customProperty": "Custom value that can be used in rules", "dailyOutLimit": "10000" }, "zoneId": "UTC+1", "txnDate": "2025-01-31 10:53:17+0000" } ``` ```json { "txnId": "general0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-29 02:30:12+0000", // Date and time of performing a transaction. "type": "userPlatformEvent", //Required. Transaction type. "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "PlatformEvent0001", // Required. Unique identifier of the transaction participant in your system. "fullName": "John Smith", // Required. Full name of the transaction participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "device": { // Information about an applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // Latitude value in decimal degrees. "lon": " 1.7976931348623157", // 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" // Applicant device IP address. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "fingerprint": "usersDeviceFing", // Device fingerprint. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en" // Language used during an online session (e.g. eng). } }, "userPlatformEventInfo": { // Required object. Information about an event which is made within a transaction. "type": "general" // Required. Type of event which is made within a transaction. }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "SingUp0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-29 02:30:12+0000", // Date and time of performing the transaction. "type": "userPlatformEvent", // Required. Transaction type. "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "PlatformEvent0001", // Required. Unique identifier of the transaction participant in your system. "fullName": "John Smith", // Required. Full name of the transaction participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "device": { // Information about the applicant device. "coords": { // Coordinates of the applicant device. "lat": -1.7976931348623157, // Latitude value in decimal degrees. "lon": " 1.7976931348623157", // Longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about the applicant device location. "ip": "242.1.1" // Applicant device IP address. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "fingerprint": "usersDeviceFing", // Device fingerprint. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en" // Language used during an online session (e.g. eng). } }, "userPlatformEventInfo": { // Required object. Information about the event which is made within the transaction. "type": "signup" // Required. Type of event which is made within the transaction. }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "login0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-29 02:30:12+0000", // Date and time of performing the transaction. "type": "userPlatformEvent", // Required. Transaction type. "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "PlatformEvent0001", // Required. Unique identifier of the transaction participant in your system. "fullName": "John Smith", // Required. Full name of the transaction participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction's participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "device": { // Information about the applicant's device. "coords": { // Coordinates of the applicant's device. "lat": -1.7976931348623157, // Latitude value in decimal degrees. "lon": " 1.7976931348623157", // Longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about the applicant device location. "ip": "242.1.1" // Applicant device IP address. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "fingerprint": "usersDeviceFing", // Device fingerprint. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en" // Language used during an online session (e.g. eng). } }, "userPlatformEventInfo": { // Required object. Information about the event which is made within the transaction. "type": "login" // Required. Type of event which is made within the transaction. }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "passwordReset0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-29 02:30:12+0000", // The date and time of performing a transaction. "type": "userPlatformEvent", // Required. Transaction type. "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": "PlatformEvent0001", // Required. Unique identifier of the transaction participant in your system. "fullName": "John Smith", // Required. Full name of the transaction participant "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction's participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "device": { // Information about the applicant's device. "coords": { // Coordinates of the applicant's device. "lat": -1.7976931348623157, // Latitude value in decimal degrees. "lon": " 1.7976931348623157", // longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about the applicant device location. "ip": "242.1.1" // Applicant device IP address. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "fingerprint": "usersDeviceFing", // Device fingerprint. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en" // Language used during an online session (e.g eng). } }, "userPlatformEventInfo": { // Required object. Information about the event which is made within the transaction. "type": "passwordReset" // Required. Type of event which is made within the transaction. }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` ```json { "txnId": "twoFaReset0001", // Required. Unique transaction identifier in your system (alphanum). "txnDate": "2024-04-29 02:30:12+0000", // Date and time of performing a transaction. "type": "userPlatformEvent", // Required. Transaction type. "applicant": { // Required object. Information about the participant of the transaction. "type": "individual", // Required. Participant entity type—company or individual. The ‘individual’ is set by default. "externalUserId": "PlatformEvent0001", // Required. Unique identifier of the transaction participant in your system. "fullName": "John Smith", // Required. Full name of the transaction's participant. "fullNameEn": "John Smith", // Optional. Full name transliterated in English. "placeOfBirth": "settlementName", // Place of birth. This can be a city, a town or another settlement type. "dob": "1995-09-30", // Date of birth. "address": { // Information about the transaction's participant address. "country": "CAN", // Alpha-3 country code per ISO 3166. "postCode": "123456", // Address post code. "town": "usersAddressTown", // City, town, or another settlement. "state": "usersAddState", // State, region, district, county or another territorial entity inside a country. "street": "usersAddSt", // Street name. "subStreet": "usersAddSbSt", // Additional information related to the street. This could be a house number or any other details. "flatNumber": "101", // Flat or apartment number. "buildingNumber": "202", // Building number. "buildingName": "usersAddBuildName", // Building name. "formattedAddress": "postCode, town, state, street, buildingNumber" // Address in a human readable format. }, "device": { // Information about the applicant’s device. "coords": { // Coordinates of an applicant's device. "lat": -1.7976931348623157, // Latitude value in decimal degrees. "lon": " 1.7976931348623157", // Longitude value in decimal degrees. "accuracy": "10" // Accuracy of the latitude and longitude properties, expressed in meters. }, "ipInfo": { // Information about the applicant device location. "ip": "242.1.1" // Applicant device IP address. }, "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", // String with the HTTP header that your web browser sends to each requested page. "sessionId": "r-v3-812412m9e12d42", // Transaction session identifier. "fingerprint": "usersDeviceFing", // Device fingerprint. "sessionAgeMs": 18, // Session lifetime in milliseconds. "acceptLang": "en" // Language used during an online session (e.g. eng). } }, "userPlatformEventInfo": { // Required object. Information about the event which is made within the transaction. "type": "twoFaReset" // Required object. Type of event which is made within the transaction. }, "props": { // Custom properties. "customProperty": "Custom value", // Custom property 1. "dailyOutLimit": "10000" // Custom property 2. } } ``` # Response explained The response is a JSON file that represents the full and structured transaction data. See the response structure, possible content with descriptions on the [following page](https://docs.sumsub.com/sumsub/reference/get-transaction#response-explained). # Errors explained The following are typical error responses that you may encounter when sending a malformed requests. ```json { "description": "Entity already exists", "code": 409 } ``` > A transaction with the related `txnId` already exists. Change it to unique. ```json { "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. ```json { "description": "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:** > > ```json > "applicant": { > "type": "individual", > "externalUserId": "PlatformEvent0001", > "fullName": "User fullname" > } > ``` ```json { "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. ```json { "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. ```json { "description": "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). ```json { "description": "App token is invalid", "code": 401, "errorCode": 4002, "errorName": "app-token-private-part-mismatch" } ``` > Check the correctness of the used app token. ```json { "description": "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. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "sumsub-api", "version": "1.0" }, "servers": [ { "url": "https://api.sumsub.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "X-App-Token", "in": "header", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/resources/applicants/{applicantId}/kyt/txns/-/data": { "post": { "summary": "Submit transaction", "description": "", "operationId": "submit-transaction-for-existing-applicant", "parameters": [ { "name": "applicantId", "in": "path", "description": "Unique identifier of the applicant who passed user verification (KYC). If you do not have such an applicant, use [Submit transaction for non-existing applicant](https://docs.sumsub.com/sumsub/reference/submit-transaction-for-non-existing-applicant) instead.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "txnId", "type" ], "properties": { "txnId": { "type": "string", "description": "Unique transaction identifier in your system (alphanumeric).

**Note:** If the specified `txnId` already exists, a `409` error code \"Entity already exists\" is returned." }, "txnDate": { "type": "string", "description": "Date and time of performing a transaction.

Format: `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000.", "format": "date-time" }, "zoneId": { "type": "string", "description": "Time zone identifier on your side provided in a form of prefix and offset, e.g., `UTC+01:00`.

Required to calculate the `txnLocalDate` [expression attribute](https://docs.sumsub.com/sumsub/reference/expression-attributes#data) value that is a transaction creation date in your provided timezone. If not provided, UTC is used by default." }, "type": { "type": "string", "description": "Transaction type.", "enum": [ "finance", "kyc", "travelRule", "userPlatformEvent" ] }, "info": { "type": "object", "description": "General information about the transaction.

⚠️ The `info` object is not used for the `userPlatformEvent` type of transaction.", "required": [ "currencyType" ], "properties": { "direction": { "type": "string", "description": "", "enum": [ "out", "in" ] }, "amount": { "type": "number", "description": "Amount of funds used in the transaction. Required for the `travelRule` and `finance` types of transaction.", "format": "double" }, "amountInDefaultCurrency": { "type": "number", "description": "Amount of funds used in the transaction in the default currency. For precise calculations, submit the converted default currency amount using this field.", "format": "double" }, "currencyType": { "type": "string", "description": "Transaction currency type: `crypto` or `fiat`." }, "currencyCode": { "type": "string", "description": "Currency code (for example, `USD`, `GBP`, `BTC`).

⚠️ Required for the `travelRule` and `finance` transaction types." }, "defaultCurrencyCode": { "type": "string", "description": "Code of the default currency (`USD`, `GBP`, `BTC`, etc)." }, "cryptoParams": { "type": "object", "description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data.", "properties": { "attemptId": { "type": "string", "description": "Unique identifier of the transaction attempt." }, "outputIndex": { "type": "integer", "description": "Index number for a transaction output.", "format": "int32" }, "cryptoChain": { "type": "string", "description": "Crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](https://docs.sumsub.com/sumsub/reference/crypto-chain-codes)." }, "contractAddress": { "type": "string", "description": "Smart-contract address of the token. Use this field to distinguish assets that share the same currencyCode and cryptoChain but represent different tokens." } } }, "paymentTxnId": { "type": "string", "description": "Unique identifier that is used to monitor a transaction in the blockchain. Used for `travelRule` transactions." }, "paymentDetails": { "type": "string", "description": "Remittance or payment reference information." }, "type": { "type": "string", "description": "String for categorizing transactions." }, "mcc": { "type": "string", "description": "4-digit number representing Merchant Category Code (MCC)." } } }, "sourceKey": { "type": "string", "description": "[Source key](/docs/source-keys) indication to separate access to transactions." }, "applicant": { "type": "object", "description": "Information about the participant of the transaction.", "required": [ "externalUserId" ], "properties": { "type": { "type": "string", "description": "Participant entity type.", "enum": [ "individual", "company" ] }, "externalUserId": { "type": "string", "description": "Unique identifier of the transaction participant (applicant or counterparty) on your side. Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant." }, "fullName": { "type": "string", "description": "Full name of the participant. Required for the `company` type of applicant." }, "fullNameEn": { "type": "string", "description": "Participant’s full name transliterated in English. Use this field to provide an English version alongside the local-language name." }, "firstName": { "type": "string", "description": "First name of the participant." }, "firstNameEn": { "type": "string", "description": "Transliterated first name." }, "lastName": { "type": "string", "description": "Last name of the participant." }, "lastNameEn": { "type": "string", "description": "Transliterated last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] }, "dob": { "type": "string", "description": "Date of birth.", "format": "date" }, "placeOfBirth": { "type": "string", "description": "Place of birth. This can be a city, a town or another settlement type." }, "registrationDate": { "type": "string", "description": "Date and time when the applicant was initially registered in your system. Format: `YYYY-MM-DD hh:mm:ss` (for example, `2025-01-15 10:20:35`).", "format": "date-time" }, "address": { "type": "object", "description": "Participant address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "device": { "type": "object", "description": "Device information.", "properties": { "userAgent": { "type": "string", "description": "String with the HTTP header that your web browser sends to each requested page. E.g. `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": { "type": "string", "description": "Transaction session identifier (e.g. `r-v3-812412m9e12d42`)." }, "sessionAgeMs": { "type": "integer", "description": "Session lifetime in milliseconds.", "format": "int64" }, "acceptLang": { "type": "string", "description": "From browser, e.g. `en`." }, "fingerprint": { "type": "string", "description": "Device fingerprint." }, "address": { "type": "object", "description": "Device address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "coords": { "type": "object", "description": "Coordinates.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "accuracy": { "type": "string", "description": "Accuracy of the latitude and longitude properties, expressed in meters." } } }, "ipInfo": { "type": "object", "description": "Data about used IP address.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "ip": { "type": "string", "description": "IP address." }, "countryCode3": { "type": "string", "description": "Country code (ISO 3166-1 alpha-3)." }, "asn": { "type": "integer", "description": "Autonomous System Number.", "format": "int32" }, "asnOrg": { "type": "string", "description": "ASN organisation." }, "riskyAsn": { "type": "boolean", "description": "Determines if the ASN is risky (`true`) or not (`false`)." } } } } }, "paymentMethod": { "type": "object", "description": "Information about the payment method.", "properties": { "type": { "type": "string", "description": "Specify the payment method type. Possible values include `bankCard`, `bankAccount`, `eWallet`, `cryptoWallet`, `other`, and so on.\n\n**Note:** The listed values are recommendations and may be extended as needed." }, "accountId": { "type": "string", "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type, and so on. Required for a counterparty in `travelRule` transactions, optional for applicants.\n\n⚠️ Mind that `accountId` is case-sensitive." }, "issuingCountry": { "type": "string", "description": "Alpha-3 code (e.g., `GBR`, `DEU`, `ARG`, etc.) of the country that issued the payment." }, "3dsUsed": { "type": "boolean", "description": "Indication of 3d secure auth being used." }, "2faUsed": { "type": "boolean", "description": "Indication of 2fa being used." }, "memo": { "type": "string", "description": "Optional field used for blockchain transactions where the receiving address is shared among multiple users (e.g., exchanges, custodians). It helps identify the specific end-user by carrying metadata such as a memo, tag, or payment ID (depending on the blockchain). This field is required for certain blockchains like XRP (destination tag), Stellar (memo), and EOS (memo)." } } }, "institutionInfo": { "type": "object", "description": "Applicant institution information.", "properties": { "code": { "type": "string", "description": "Institution code (e.g. BIC)." }, "name": { "type": "string", "description": "Institution name (e.g., Wells Fargo)." }, "address": { "type": "object", "description": "Institution address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } } } }, "email": { "type": "string", "description": "Email address" }, "phone": { "type": "string", "description": "Phone number." }, "idDoc": { "type": "object", "description": "Information from the applicant documents.", "properties": { "number": { "type": "string", "description": "Registration number of the document." }, "country": { "type": "string", "description": "Alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on) of the country where the document was issued." }, "idDocType": { "type": "string", "description": "

Type of document that is specified in the level to be provided for verification. For example, `PASSPORT`, `UTILITY_BILL`, `VEHICLE_REGISTRATION_CERTIFICATE`, and so on.

See the lists of supported document types and supported company document types for details.

" }, "registrationAuthority": { "type": "string", "description": "Official name of the authority that registered the document." } } }, "residenceCountry": { "type": "string", "description": "Country of residence. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "leiCode": { "type": "string", "description": "Refers to a Legal Entity Identifier (LEI) code—public identifier from the financial entities registry." }, "licenseNumber": { "type": "string", "description": "Number of a license assigned for a time-bound term for a specific activity type, like banking or gambling. Applicable to the `company` type." }, "registrationNumber": { "type": "string", "description": "Primary identification number assigned to a legal entity during the registration process. Applicable to the `company` type." }, "companyType": { "type": "string", "description": "Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on." }, "ceo": { "type": "object", "description": "Data related to the company's Chief Executive Officer.", "properties": { "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] } } } } }, "counterparty": { "type": "object", "description": "Information about the sender/receiver, depending on the transaction direction.", "properties": { "type": { "type": "string", "description": "Participant entity type.

ⓘ Required for Travel Rule transactions only.", "enum": [ "individual", "company" ] }, "externalUserId": { "type": "string", "description": "Unique identifier of the transaction participant (applicant or counterparty) on your side. Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserId` for the same counterparty or applicant.

⚠️ While this field is optional, it becomes required if you plan to use aggregation-based rules (for example, rules that evaluate a counterparty’s past transaction history). In such cases, you must provide a consistent `externalUserId` for that counterparty across all transactions." }, "fullName": { "type": "string", "description": "Full name of the participant. Required for the `company` type of applicant." }, "fullNameEn": { "type": "string", "description": "Participant’s full name transliterated in English. Use this field to provide an English version alongside the local-language name." }, "firstName": { "type": "string", "description": "First name." }, "firstNameEn": { "type": "string", "description": "Transliterated first name." }, "lastName": { "type": "string", "description": "Last name." }, "lastNameEn": { "type": "string", "description": "Transliterated last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] }, "dob": { "type": "string", "description": "Date of birth.", "format": "date" }, "placeOfBirth": { "type": "string", "description": "Place of birth. This can be a city, a town or another settlement type." }, "address": { "type": "object", "description": "Participant address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "device": { "type": "object", "description": "Device information.", "properties": { "userAgent": { "type": "string", "description": "String with the HTTP header that your web browser sends to each requested page. E.g. `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": { "type": "string", "description": "Transaction session identifier (e.g. `r-v3-812412m9e12d42`)." }, "sessionAgeMs": { "type": "integer", "description": "Session lifetime in milliseconds.", "format": "int64" }, "acceptLang": { "type": "string", "description": "From browser, e.g. `en`." }, "fingerprint": { "type": "string", "description": "Device fingerprint." }, "address": { "type": "object", "description": "Device address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "coords": { "type": "object", "description": "Coordinates.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "accuracy": { "type": "string", "description": "Accuracy of the latitude and longitude properties, expressed in meters." } } }, "ipInfo": { "type": "object", "description": "Data about used IP address.", "properties": { "lat": { "type": "number", "description": "Position latitude in decimal degrees.", "format": "double" }, "lon": { "type": "number", "description": "Position longitude in decimal degrees.", "format": "double" }, "ip": { "type": "string", "description": "IP address." }, "countryCode3": { "type": "string", "description": "Country code (ISO 3166-1 alpha-3)." }, "asn": { "type": "integer", "description": "Autonomous System Number.", "format": "int32" }, "asnOrg": { "type": "string", "description": "ASN organisation." }, "riskyAsn": { "type": "boolean", "description": "Determines if the ASN is risky (`true`) or not (`false`)." } } } } }, "paymentMethod": { "type": "object", "description": "Information about the payment method.", "properties": { "type": { "type": "string", "description": "Specify the payment method type. Possible values include `bankCard`, `bankAccount`, `eWallet`, `cryptoWallet`, `other`, and so on.\n\n**Note:** The listed values are recommendations and may be extended as needed." }, "accountId": { "type": "string", "description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type, and so on. Required for a counterparty in `travelRule` transactions, optional for applicants.\n\n⚠️ Mind that `accountId` is case-sensitive." }, "issuingCountry": { "type": "string", "description": "Alpha-3 code (e.g., `GBR`, `DEU`, `ARG`, etc.) of the country that issued the payment." }, "3dsUsed": { "type": "boolean", "description": "Indication of 3d secure auth being used." }, "2faUsed": { "type": "boolean", "description": "Indication of 2fa being used." }, "memo": { "type": "string", "description": "Optional field used for blockchain transactions where the receiving address is shared among multiple users (e.g., exchanges, custodians). It helps identify the specific end-user by carrying metadata such as a memo, tag, or payment ID (depending on the blockchain). This field is required for certain blockchains like XRP (destination tag), Stellar (memo), and EOS (memo)." } } }, "institutionInfo": { "type": "object", "description": "Counterparty institution information.", "properties": { "code": { "type": "string", "description": "Institution code (e.g. BIC)." }, "name": { "type": "string", "description": "Institution name (e.g. Wells Fargo)." }, "address": { "type": "object", "description": "Institution address.", "properties": { "country": { "type": "string", "description": "Alpha-3 country code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "postCode": { "type": "string", "description": "Address postal code." }, "town": { "type": "string", "description": "The city, town, or another settlement." }, "street": { "type": "string", "description": "Street name." }, "subStreet": { "type": "string", "description": "Additional information related to the street. This could be a house number or any other details." }, "state": { "type": "string", "description": "The state, region, district, county or another territorial entity inside a country (if applicable)." }, "buildingName": { "type": "string", "description": "Building name (if applicable)." }, "flatNumber": { "type": "string", "description": "Flat or apartment number." }, "buildingNumber": { "type": "string", "description": "Building number." }, "formattedAddress": { "type": "string", "description": "Address in a human readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`." } } }, "internalId": { "type": "string", "description": "VASP ID for counterparty transactions. If provided, we trust the exchange and use the expected VASP for transaction approval. If not provided, we will attempt to find the VASP by the wallet address.

ⓘ Applicable to Travel Rule transactions only." } } }, "email": { "type": "string", "description": "Email address." }, "phone": { "type": "string", "description": "Phone number." }, "idDoc": { "type": "object", "description": "Information from the counterparty documents.", "properties": { "number": { "type": "string", "description": "Registration number of the document." }, "country": { "type": "string", "description": "Alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on) of the country where the document was issued." }, "idDocType": { "type": "string", "description": "

Type of document that is specified in the level to be provided for verification. For example, `PASSPORT`, `UTILITY_BILL`, `VEHICLE_REGISTRATION_CERTIFICATE`, and so on.

See the lists of supported document types and supported company document types for details.

" }, "registrationAuthority": { "type": "string", "description": "Official name of the authority that registered the document." } } }, "residenceCountry": { "type": "string", "description": "Country of residence. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`, and so on)." }, "leiCode": { "type": "string", "description": "Refers to a Legal Entity Identifier (LEI) code—public identifier from the financial entities registry." }, "licenseNumber": { "type": "string", "description": "Number of a license assigned for a time-bound term for a specific activity type, like banking or gambling. Applicable to the `company` type." }, "registrationNumber": { "type": "string", "description": "Primary identification number assigned to a legal entity during the registration process. Applicable to the `company` type." }, "companyType": { "type": "string", "description": "Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on." }, "ceo": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name." }, "lastName": { "type": "string", "description": "Last name." }, "nameType": { "type": "string", "description": "Name type.", "enum": [ "aliasName", "birthName", "maidenName", "legalName", "shortName", "tradingName", "other" ] } } } } }, "userPlatformEventInfo": { "type": "object", "description": "Information about the event sent within the transaction.

⚠️ Used only for the `userPlatformEvent` type of transaction.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Event type sent within the transaction: `login`, `failedLogin`, `signup`, `passwordReset`, `twoFaReset`, `general`." }, "passwordHash": { "type": "string", "description": "A hashed representation of the user’s password, used to detect and prevent fraud by identifying repeated use of the same password across multiple accounts." } } }, "props": { "type": "object", "description": "Map of strings in JSON format with custom keys and string values. Represents transaction properties.", "properties": { "customProperty": { "type": "string", "description": "If you want to add more custom properties, add as many key-value pairs to the request body as you need.

ⓘ `camelCase` for the property indicator is preferred (e.g., `customPropertyOne`)." }, "customPropertyTwo": { "type": "string" }, "customPropertyThree": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "USERPLATFORM EVENT GENERAL": { "value": "{\n \"id\": \"66335d9a243caf315d8c36ef\",\n \"applicantId\": \"662edfdb7a26397a65d3bdc6\",\n \"scope\": \"events\",\n \"externalUserId\": \"PlatformEvent0001\",\n \"clientId\": \"korban.inc\",\n \"data\": {\n \"txnId\": \"general0001\",\n \"txnDate\": \"2024-04-29 02:30:12+0000\",\n \"type\": \"userPlatformEvent\", \n \"applicant\": {\n \"externalUserId\": \"PlatformEvent0001\",\n \"fullName\": \"Users Fullname\",\n \"fullNameEn\": \"Users Fullname\",\n \"placeOfBirth\": \"settlementName\",\n \"dob\": \"1995-09-30\",\n \"address\": {\n \"buildingName\": \"usersAddBuildName\",\n \"flatNumber\": \"101\",\n \"subStreet\": \"usersAddSbSt\",\n \"subStreetEn\": \"usersAddSbStEn\",\n \"street\": \"usersAddSt\",\n \"streetEn\": \"usersAddStEn\",\n \"state\": \"usersAddState\",\n \"stateEn\": \"usersAddStateEn\",\n \"buildingNumber\": \"202\",\n \"town\": \"usersAddressTown\",\n \"townEn\": \"usersAddressTownEn\",\n \"postCode\": \"123456\",\n \"country\": \"CAN\",\n \"formattedAddress\": \"postCode, town, state, street, buildingNumber\"\n },\n \"type\": \"individual\",\n \"device\": {\n \"ipInfo\": {\n \"ip\": \"178.123.68.138\",\n \"riskyAsn\": false\n },\n \"userAgent\": \"usersDeviceUA\",\n \"sessionId\": \"usersDeviceSesId\",\n \"sessionAgeMs\": 18,\n \"acceptLang\": \"en\",\n \"coords\": {\n \"lat\": -1.7976931348623157,\n \"lon\": 1.7976931348623157,\n \"accuracy\": 10\n },\n \"fingerprint\": \"usersDeviceFing\"\n },\n \"paymentMethodExtractedInfo\": {\n \"type\": \"smartContract\"\n }, \n },\n \"userPlatformEventInfo\": {\n \"type\": \"general\"\n },\n \"props\": {\n \"customProperty\": \"Custom value\",\n \"dailyOutLimit\": \"10000\"\n }\n },\n \"score\": 0,\n \"review\": {\n \"reviewId\": \"XvSHf\",\n \"attemptId\": \"QaUMN\",\n \"attemptCnt\": 1,\n \"elapsedSincePendingMs\": 149,\n \"elapsedSinceQueuedMs\": 149,\n \"createDate\": \"2024-05-02 09:32:10+0000\",\n \"reviewResult\": {\n \"reviewAnswer\": \"GREEN\"\n },\n \"reviewStatus\": \"completed\"\n },\n \"createdAt\": \"2024-05-02 09:32:10+0000\",\n \"scoringResult\": {\n \"score\": 0,\n \"dryScore\": 0,\n \"matchedRules\": [\n {\n \"id\": \"6602a0f43d40c8131dc4e17a\",\n \"name\": \"AFP1-agg-beh-eve-for-user-pla-eve-BBKP\",\n \"revision\": 1,\n \"title\": \"Aggregate behavioral events for user platform events\",\n \"score\": 0,\n \"dryRun\": false,\n \"action\": \"score\",\n \"stage\": \"pre\",\n \"preScoringRunnerType\": \"behavioralEvents\"\n }\n ],\n \"unmatchedRules\": [],\n \"action\": \"score\",\n \"ruleCnt\": 2,\n \"dryRunRuleCnt\": 0,\n \"tagScores\": []\n },\n \"typedTags\": [],\n \"txnInactive\": false\n}" }, "USERPLATFORM EVENT TWOFARESET": { "value": { "id": "66335c8c243caf315d8c357c", "applicantId": "662edfdb7a26397a65d3bdc6", "scope": "events", "externalUserId": "PlatformEvent0001", "clientId": "korban.inc", "data": { "txnId": "twoFaReset0001", "txnDate": "2024-04-29 02:30:12+0000", "type": "userPlatformEvent", "applicant": { "externalUserId": "PlatformEvent0001", "fullName": "Users Fullname", "fullNameEn": "Users Fullname", "placeOfBirth": "settlementName", "dob": "1995-09-30", "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", "device": { "ipInfo": { "ip": "178.123.68.138", "riskyAsn": false }, "userAgent": "usersDeviceUA", "sessionId": "usersDeviceSesId", "sessionAgeMs": 18, "acceptLang": "en", "coords": { "lat": -1.7976931348623157, "lon": 1.7976931348623157, "accuracy": 10 }, "fingerprint": "usersDeviceFing" }, "paymentMethodExtractedInfo": { "type": "smartContract" } }, "userPlatformEventInfo": { "type": "twoFaReset" }, "props": { "customProperty": "Custom value", "dailyOutLimit": "10000" } }, "score": 0, "review": { "reviewId": "azlir", "attemptId": "RPgcu", "attemptCnt": 1, "elapsedSincePendingMs": 238, "elapsedSinceQueuedMs": 238, "createDate": "2024-05-02 09:27:40+0000", "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "createdAt": "2024-05-02 09:27:40+0000", "scoringResult": { "score": 0, "dryScore": 0, "matchedRules": [ { "id": "6602a0f43d40c8131dc4e17a", "name": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP", "revision": 1, "title": "Aggregate behavioral events for user platform events", "score": 0, "dryRun": false, "action": "score", "stage": "pre", "preScoringRunnerType": "behavioralEvents" } ], "unmatchedRules": [], "action": "score", "ruleCnt": 2, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } }, "USERPLATFORM EVENT PASSWORDRESET": { "value": { "id": "662f6a0bd331c86d8fbd2a2a", "applicantId": "662edfdb7a26397a65d3bdc6", "scope": "events", "externalUserId": "PlatformEvent0001", "clientId": "korban.inc", "data": { "txnId": "passwordReset0001", "txnDate": "2024-04-29 02:30:12+0000", "type": "userPlatformEvent", "applicant": { "externalUserId": "PlatformEvent0001", "fullName": "Users Fullname", "fullNameEn": "Users Fullname", "placeOfBirth": "settlementName", "dob": "1995-09-30", "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", "device": { "ipInfo": { "ip": "178.123.68.138", "riskyAsn": false }, "userAgent": "usersDeviceUA", "sessionId": "usersDeviceSesId", "sessionAgeMs": 18, "acceptLang": "en", "coords": { "lat": -1.7976931348623157, "lon": 1.7976931348623157, "accuracy": 10 }, "fingerprint": "usersDeviceFing" }, "paymentMethodExtractedInfo": { "type": "smartContract" } }, "userPlatformEventInfo": { "type": "passwordReset" }, "props": { "customProperty": "Custom value", "dailyOutLimit": "10000" } }, "score": 0, "review": { "reviewId": "zmVtx", "attemptId": "qXMXt", "attemptCnt": 1, "elapsedSincePendingMs": 117, "elapsedSinceQueuedMs": 117, "createDate": "2024-04-29 09:36:11+0000", "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "createdAt": "2024-04-29 09:36:11+0000", "scoringResult": { "score": 0, "dryScore": 0, "matchedRules": [ { "id": "6602a0f43d40c8131dc4e17a", "name": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP", "revision": 1, "title": "Aggregate behavioral events for user platform events", "score": 0, "dryRun": false, "action": "score", "stage": "pre", "preScoringRunnerType": "behavioralEvents" } ], "unmatchedRules": [], "action": "score", "ruleCnt": 2, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } }, "USERPLATFORM EVENT LOGIN": { "value": { "id": "662f6958d331c86d8fbd2927", "applicantId": "662edfdb7a26397a65d3bdc6", "scope": "events", "externalUserId": "PlatformEvent0001", "clientId": "korban.inc", "data": { "txnId": "login0001", "txnDate": "2024-04-29 02:30:12+0000", "type": "userPlatformEvent", "applicant": { "externalUserId": "PlatformEvent0001", "fullName": "Users Fullname", "fullNameEn": "Users Fullname", "placeOfBirth": "settlementName", "dob": "1995-09-30", "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", "device": { "ipInfo": { "ip": "178.123.68.138", "riskyAsn": false }, "userAgent": "usersDeviceUA", "sessionId": "usersDeviceSesId", "sessionAgeMs": 18, "acceptLang": "en", "coords": { "lat": -1.7976931348623157, "lon": 1.7976931348623157, "accuracy": 10 }, "fingerprint": "usersDeviceFing" }, "paymentMethodExtractedInfo": { "type": "smartContract" } }, "userPlatformEventInfo": { "type": "login" }, "props": { "customProperty": "Custom value", "dailyOutLimit": "10000" } }, "score": 0, "review": { "reviewId": "zyxYV", "attemptId": "AdLNF", "attemptCnt": 1, "elapsedSincePendingMs": 101, "elapsedSinceQueuedMs": 101, "createDate": "2024-04-29 09:33:12+0000", "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "createdAt": "2024-04-29 09:33:12+0000", "scoringResult": { "score": 0, "dryScore": 0, "matchedRules": [ { "id": "6602a0f43d40c8131dc4e17a", "name": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP", "revision": 1, "title": "Aggregate behavioral events for user platform events", "score": 0, "dryRun": false, "action": "score", "stage": "pre", "preScoringRunnerType": "behavioralEvents" } ], "unmatchedRules": [], "action": "score", "ruleCnt": 2, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } }, "USERPLATFORM EVENT SIGNUP": { "value": { "id": "662edfdb7a26397a65d3bdcb", "applicantId": "662edfdb7a26397a65d3bdc6", "scope": "events", "externalUserId": "PlatformEvent0001", "clientId": "korban.inc", "data": { "txnId": "SingUp0001", "txnDate": "2024-04-29 02:30:12+0000", "type": "userPlatformEvent", "applicant": { "externalUserId": "PlatformEvent0001", "fullName": "Users Fullname", "fullNameEn": "Users Fullname", "placeOfBirth": "settlementName", "dob": "1995-09-30", "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", "device": { "ipInfo": { "ip": "178.123.68.138", "riskyAsn": false }, "userAgent": "usersDeviceUA", "sessionId": "usersDeviceSesId", "sessionAgeMs": 18, "acceptLang": "en", "coords": { "lat": -1.7976931348623157, "lon": 1.7976931348623157, "accuracy": 10 }, "fingerprint": "usersDeviceFing" }, "paymentMethodExtractedInfo": { "type": "smartContract" } }, "userPlatformEventInfo": { "type": "signup" }, "props": { "customProperty": "Custom value", "dailyOutLimit": "10000" } }, "score": 0, "review": { "reviewId": "pqDHO", "attemptId": "byjNX", "attemptCnt": 1, "elapsedSincePendingMs": 212, "elapsedSinceQueuedMs": 212, "createDate": "2024-04-28 23:46:35+0000", "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "createdAt": "2024-04-28 23:46:35+0000", "scoringResult": { "score": 0, "dryScore": 0, "matchedRules": [ { "id": "6602a0f43d40c8131dc4e17a", "name": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP", "revision": 1, "title": "Aggregate behavioral events for user platform events", "score": 0, "dryRun": false, "action": "score", "stage": "pre", "preScoringRunnerType": "behavioralEvents" } ], "unmatchedRules": [], "action": "score", "ruleCnt": 2, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } }, "CRYPTO/CRYSTAL OUT TXN": { "value": "{\n \"id\": \"6638d6bf26d0f119b6fbd5f0\",\n \"applicantId\": \"6638d4fea34063225deb5886\",\n \"scope\": \"events\",\n \"externalUserId\": \"Crypto0001\",\n \"clientId\": \"korban.inc\",\n \"data\": {\n \"txnId\": \"crypto0001\",\n \"txnDate\": \"2024-04-04 10:50:00+0000\",\n \"type\": \"finance\",\n \"info\": {\n \"paymentTxnId\": \"txnHash\",\n \"type\": \"customType\",\n \"direction\": \"out\",\n \"amount\": 10,\n \"currencyCode\": \"BTC\",\n \"currencyType\": \"crypto\",\n \"amountInDefaultCurrency\": 588235.2941176471,\n \"defaultCurrencyCode\": \"EUR\",\n \"paymentDetails\": \"InfoDetails\"\n },\n \"applicant\": {\n \"externalUserId\": \"Crypto0001\",\n \"fullName\": \"Users Fullname\",\n \"fullNameEn\": \"Users Fullname\",\n \"placeOfBirth\": \"settlementName\",\n \"dob\": \"1995-09-30\",\n \"address\": {\n \"buildingName\": \"usersAddBuildName\",\n \"flatNumber\": \"101\",\n \"subStreet\": \"usersAddSbSt\",\n \"subStreetEn\": \"usersAddSbStEn\",\n \"street\": \"usersAddSt\",\n \"streetEn\": \"usersAddStEn\",\n \"state\": \"usersAddState\",\n \"stateEn\": \"usersAddStateEn\",\n \"buildingNumber\": \"202\",\n \"town\": \"usersAddressTown\",\n \"townEn\": \"usersAddressTownEn\",\n \"postCode\": \"123456\",\n \"country\": \"CAN\",\n \"formattedAddress\": \"postCode, town, state, street, buildingNumber\"\n },\n \"type\": \"individual\",\n \"paymentMethod\": {\n \"type\": \"crypto\",\n \"accountId\": \"usersWalletAddress\",\n \"issuingCountry\": \"CAN\"\n },\n \"paymentMethodExtractedInfo\": {\n \"type\": \"smartContract\"\n },\n \"device\": {\n \"ipInfo\": {\n \"ip\": \"178.123.68.138\",\n \"countryCode2\": \"PL\",\n \"countryCode3\": \"POL\",\n \"city\": \"Zhytkavichy\",\n \"zipCode\": \"225749\",\n \"lat\": 300,\n \"lon\": 500,\n \"asn\": 6697,\n \"asnOrg\": \"Republican Unitary Telecommunication Enterprise Poltelecom\",\n \"riskyAsn\": false\n },\n \"userAgent\": \"usersDeviceUA\",\n \"sessionId\": \"usersDeviceSesId\",\n \"sessionAgeMs\": 18,\n \"acceptLang\": \"en\",\n \"fingerprint\": \"usersDeviceFing\"\n },\n \"institutionInfo\": {\n \"code\": \"InstCode\",\n \"name\": \"InstName\",\n \"address\": {\n \"country\": \"PRT\"\n },\n \"internalId\": \"vaspInternalId\"\n }\n },\n \"counterparty\": {\n \"externalUserId\": \"cpExtId\",\n \"fullName\": \"CP Name\",\n \"fullNameEn\": \"CP Name\",\n \"placeOfBirth\": \"settlementName\",\n \"dob\": \"1995-09-30\",\n \"address\": {\n \"buildingName\": \"cpBuildingName\",\n \"flatNumber\": \"303\",\n \"subStreet\": \"cpSubStreet\",\n \"subStreetEn\": \"cpSubStreetEn\",\n \"street\": \"cpStreet\",\n \"streetEn\": \"cpStreetEn\",\n \"state\": \"cpState\",\n \"stateEn\": \"cpStateEn\",\n \"buildingNumber\": \"404\",\n \"town\": \"cpTown\",\n \"townEn\": \"cpTownEn\",\n \"postCode\": \"987654\",\n \"country\": \"QAT\",\n \"formattedAddress\": \"postCode, town, state, street, buildingNumber\"\n },\n \"type\": \"individual\",\n \"paymentMethod\": {\n \"type\": \"crypto\",\n \"accountId\": \"cpWalletAddress\",\n \"issuingCountry\": \"SVN\"\n },\n \"paymentMethodExtractedInfo\": {\n \"type\": \"smartContract\"\n },\n \"device\": {\n \"ipInfo\": {\n \"ip\": \"62.228.108.249\",\n \"countryCode2\": \"CY\",\n \"countryCode3\": \"CYP\",\n \"city\": \"Nicosia\",\n \"lat\": 600,\n \"lon\": 700,\n \"asn\": 6866,\n \"asnOrg\": \"Cyprus Telecommunications Authority\",\n \"riskyAsn\": false\n },\n \"userAgent\": \"cpDevUA\",\n \"sessionId\": \"cpDevSess\",\n \"sessionAgeMs\": 18,\n \"acceptLang\": \"en\",\n \"fingerprint\": \"cpDevFing\"\n },\n \"institutionInfo\": {\n \"code\": \"cpInstCode\",\n \"name\": \"cpInstName\",\n \"address\": {\n \"country\": \"PAN\"\n },\n \"internalId\": \"vaspInternalId\"\n }\n },\n \"props\": {\n \"customProperty\": \"Custom value\",\n \"dailyOutLimit\": \"10000\"\n }\n },\n \"score\": 0,\n \"review\": {\n \"reviewId\": \"nYnHx\",\n \"attemptId\": \"LMkcV\",\n \"attemptCnt\": 1,\n \"elapsedSincePendingMs\": 139,\n \"elapsedSinceQueuedMs\": 139,\n \"createDate\": \"2024-05-06 13:10:23+0000\",\n \"reviewResult\": {\n \"reviewAnswer\": \"GREEN\"\n },\n \"reviewStatus\": \"completed\"\n },\n \"createdAt\": \"2024-05-06 13:10:23+0000\",\n \"scoringResult\": {\n \"score\": 0,\n \"dryScore\": 0,\n \"matchedRules\": [],\n \"unmatchedRules\": [],\n \"action\": \"score\",\n \"ruleCnt\": 0,\n \"dryRunRuleCnt\": 0,\n \"tagScores\": []\n },\n \"typedTags\": [],\n \"txnInactive\": false\n}En" }, "CRYPTO/CRYSTAL IN TXN": { "value": { "id": "6638d6bf26d0f119b6fbd5f0", "applicantId": "6638d4fea34063225deb5886", "scope": "events", "externalUserId": "Crypto0001", "clientId": "korban.inc", "data": { "txnId": "crypto0001", "txnDate": "2024-04-04 10:50:00+0000", "type": "finance", "info": { "paymentTxnId": "txnHash", "type": "customType", "direction": "in", "amount": 10, "currencyCode": "BTC", "currencyType": "crypto", "amountInDefaultCurrency": 588235.2941176471, "defaultCurrencyCode": "EUR", "paymentDetails": "InfoDetails" }, "applicant": { "externalUserId": "Crypto0001", "fullName": "Users Fullname", "fullNameEn": "Users Fullname", "placeOfBirth": "settlementName", "dob": "1995-09-30", "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": "crypto", "accountId": "usersWalletAddress", "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", "placeOfBirth": "settlementName", "dob": "1995-09-30", "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": "crypto", "accountId": "cpWalletAddress", "issuingCountry": "SVN" }, "paymentMethodExtractedInfo": { "type": "smartContract" }, "device": { "ipInfo": { "ip": "62.228.108.249", "countryCode2": "CY", "countryCode3": "CYP", "city": "Nicosia", "lat": 600, "lon": 700, "asn": 6866, "asnOrg": "Cyprus Telecommunications Authority", "riskyAsn": false }, "userAgent": "cpDevUA", "sessionId": "cpDevSess", "sessionAgeMs": 18, "acceptLang": "en", "fingerprint": "cpDevFing" }, "institutionInfo": { "code": "cpInstCode", "name": "cpInstName", "address": { "country": "PAN" }, "internalId": "vaspInternalId" } }, "props": { "customProperty": "Custom value", "dailyOutLimit": "10000" } }, "score": 0, "review": { "reviewId": "nYnHx", "attemptId": "LMkcV", "attemptCnt": 1, "elapsedSincePendingMs": 139, "elapsedSinceQueuedMs": 139, "createDate": "2024-05-06 13:10:23+0000", "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "createdAt": "2024-05-06 13:10:23+0000", "scoringResult": { "score": 0, "dryScore": 0, "matchedRules": [], "unmatchedRules": [], "action": "score", "ruleCnt": 0, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } }, "FIAT OUT": { "value": { "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": "usersWalletAddress", "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": [], "unmatchedRules": [], "action": "score", "ruleCnt": 0, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } }, "FIAT IN": { "value": { "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": "in", "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", "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": "usersWalletAddress", "issuingCountry": "CAN" }, "placeOfBirth": "settlementName", "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": [], "unmatchedRules": [], "action": "score", "ruleCnt": 0, "dryRunRuleCnt": 0, "tagScores": [] }, "typedTags": [], "txnInactive": false } } }, "schema": { "oneOf": [ { "title": "USERPLATFORM EVENT TWOFARESET", "type": "object", "properties": { "id": { "type": "string", "example": "66335c8c243caf315d8c357c" }, "applicantId": { "type": "string", "example": "662edfdb7a26397a65d3bdc6" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "twoFaReset0001" }, "txnDate": { "type": "string", "example": "2024-04-29 02:30:12+0000" }, "type": { "type": "string", "example": "userPlatformEvent" }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "coords": { "type": "object", "properties": { "lat": { "type": "number", "example": -1.7976931348623157, "default": 0 }, "lon": { "type": "number", "example": 1.7976931348623157, "default": 0 }, "accuracy": { "type": "integer", "example": 10, "default": 0 } } }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } } } }, "userPlatformEventInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "twoFaReset" } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "azlir" }, "attemptId": { "type": "string", "example": "RPgcu" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 238, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 238, "default": 0 }, "createDate": { "type": "string", "example": "2024-05-02 09:27:40+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-05-02 09:27:40+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6602a0f43d40c8131dc4e17a" }, "name": { "type": "string", "example": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP" }, "revision": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Aggregate behavioral events for user platform events" }, "score": { "type": "integer", "example": 0, "default": 0 }, "dryRun": { "type": "boolean", "example": false, "default": true }, "action": { "type": "string", "example": "score" }, "stage": { "type": "string", "example": "pre" }, "preScoringRunnerType": { "type": "string", "example": "behavioralEvents" } } } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 2, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "USERPLATFORM EVENT PASSWORDRESET", "type": "object", "properties": { "id": { "type": "string", "example": "662f6a0bd331c86d8fbd2a2a" }, "applicantId": { "type": "string", "example": "662edfdb7a26397a65d3bdc6" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "passwordReset0001" }, "txnDate": { "type": "string", "example": "2024-04-29 02:30:12+0000" }, "type": { "type": "string", "example": "userPlatformEvent" }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "coords": { "type": "object", "properties": { "lat": { "type": "number", "example": -1.7976931348623157, "default": 0 }, "lon": { "type": "number", "example": 1.7976931348623157, "default": 0 }, "accuracy": { "type": "integer", "example": 10, "default": 0 } } }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } } } }, "userPlatformEventInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "passwordReset" } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "zmVtx" }, "attemptId": { "type": "string", "example": "qXMXt" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 117, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 117, "default": 0 }, "createDate": { "type": "string", "example": "2024-04-29 09:36:11+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-04-29 09:36:11+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6602a0f43d40c8131dc4e17a" }, "name": { "type": "string", "example": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP" }, "revision": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Aggregate behavioral events for user platform events" }, "score": { "type": "integer", "example": 0, "default": 0 }, "dryRun": { "type": "boolean", "example": false, "default": true }, "action": { "type": "string", "example": "score" }, "stage": { "type": "string", "example": "pre" }, "preScoringRunnerType": { "type": "string", "example": "behavioralEvents" } } } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 2, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "USERPLATFORM EVENT LOGIN", "type": "object", "properties": { "id": { "type": "string", "example": "662f6958d331c86d8fbd2927" }, "applicantId": { "type": "string", "example": "662edfdb7a26397a65d3bdc6" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "login0001" }, "txnDate": { "type": "string", "example": "2024-04-29 02:30:12+0000" }, "type": { "type": "string", "example": "userPlatformEvent" }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "coords": { "type": "object", "properties": { "lat": { "type": "number", "example": -1.7976931348623157, "default": 0 }, "lon": { "type": "number", "example": 1.7976931348623157, "default": 0 }, "accuracy": { "type": "integer", "example": 10, "default": 0 } } }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } } } }, "userPlatformEventInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "login" } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "zyxYV" }, "attemptId": { "type": "string", "example": "AdLNF" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 101, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 101, "default": 0 }, "createDate": { "type": "string", "example": "2024-04-29 09:33:12+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-04-29 09:33:12+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6602a0f43d40c8131dc4e17a" }, "name": { "type": "string", "example": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP" }, "revision": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Aggregate behavioral events for user platform events" }, "score": { "type": "integer", "example": 0, "default": 0 }, "dryRun": { "type": "boolean", "example": false, "default": true }, "action": { "type": "string", "example": "score" }, "stage": { "type": "string", "example": "pre" }, "preScoringRunnerType": { "type": "string", "example": "behavioralEvents" } } } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 2, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "USERPLATFORM EVENT SIGNUP", "type": "object", "properties": { "id": { "type": "string", "example": "662edfdb7a26397a65d3bdcb" }, "applicantId": { "type": "string", "example": "662edfdb7a26397a65d3bdc6" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "SingUp0001" }, "txnDate": { "type": "string", "example": "2024-04-29 02:30:12+0000" }, "type": { "type": "string", "example": "userPlatformEvent" }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "PlatformEvent0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "coords": { "type": "object", "properties": { "lat": { "type": "number", "example": -1.7976931348623157, "default": 0 }, "lon": { "type": "number", "example": 1.7976931348623157, "default": 0 }, "accuracy": { "type": "integer", "example": 10, "default": 0 } } }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } } } }, "userPlatformEventInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "signup" } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "pqDHO" }, "attemptId": { "type": "string", "example": "byjNX" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 212, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 212, "default": 0 }, "createDate": { "type": "string", "example": "2024-04-28 23:46:35+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-04-28 23:46:35+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6602a0f43d40c8131dc4e17a" }, "name": { "type": "string", "example": "AFP1-agg-beh-eve-for-user-pla-eve-BBKP" }, "revision": { "type": "integer", "example": 1, "default": 0 }, "title": { "type": "string", "example": "Aggregate behavioral events for user platform events" }, "score": { "type": "integer", "example": 0, "default": 0 }, "dryRun": { "type": "boolean", "example": false, "default": true }, "action": { "type": "string", "example": "score" }, "stage": { "type": "string", "example": "pre" }, "preScoringRunnerType": { "type": "string", "example": "behavioralEvents" } } } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 2, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "CRYPTO/CRYSTAL OUT TXN", "type": "object", "properties": { "id": { "type": "string", "example": "6638d6bf26d0f119b6fbd5f0" }, "applicantId": { "type": "string", "example": "6638d4fea34063225deb5886" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "Crypto0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "crypto0001" }, "txnDate": { "type": "string", "example": "2024-04-04 10:50:00+0000" }, "type": { "type": "string", "example": "finance" }, "info": { "type": "object", "properties": { "paymentTxnId": { "type": "string", "example": "txnHash" }, "type": { "type": "string", "example": "customType" }, "direction": { "type": "string", "example": "out" }, "amount": { "type": "integer", "example": 10, "default": 0 }, "currencyCode": { "type": "string", "example": "BTC" }, "currencyType": { "type": "string", "example": "crypto" }, "amountInDefaultCurrency": { "type": "number", "example": 588235.2941176471, "default": 0 }, "defaultCurrencyCode": { "type": "string", "example": "EUR" }, "paymentDetails": { "type": "string", "example": "InfoDetails" } } }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "Crypto0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "crypto" }, "accountId": { "type": "string", "example": "usersWalletAddress" }, "issuingCountry": { "type": "string", "example": "CAN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "countryCode2": { "type": "string", "example": "PL" }, "countryCode3": { "type": "string", "example": "POL" }, "city": { "type": "string", "example": "Zhytkavichy" }, "zipCode": { "type": "string", "example": "225749" }, "lat": { "type": "integer", "example": 300, "default": 0 }, "lon": { "type": "integer", "example": 500, "default": 0 }, "asn": { "type": "integer", "example": 6697, "default": 0 }, "asnOrg": { "type": "string", "example": "Republican Unitary Telecommunication Enterprise Poltelecom" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "InstCode" }, "name": { "type": "string", "example": "InstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PRT" } } }, "internalId": { "type": "string", "example": "vaspInternalId" } } } } }, "counterparty": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "cpExtId" }, "fullName": { "type": "string", "example": "CP Name" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "cpBuildingName" }, "flatNumber": { "type": "string", "example": "303" }, "subStreet": { "type": "string", "example": "cpSubStreet" }, "subStreetEn": { "type": "string", "example": "cpSubStreetEn" }, "street": { "type": "string", "example": "cpStreet" }, "streetEn": { "type": "string", "example": "cpStreetEn" }, "state": { "type": "string", "example": "cpState" }, "stateEn": { "type": "string", "example": "cpStateEn" }, "buildingNumber": { "type": "string", "example": "404" }, "town": { "type": "string", "example": "cpTown" }, "townEn": { "type": "string", "example": "cpTownEn" }, "postCode": { "type": "string", "example": "987654" }, "country": { "type": "string", "example": "QAT" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "crypto" }, "accountId": { "type": "string", "example": "cpWalletAddress" }, "issuingCountry": { "type": "string", "example": "SVN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "62.228.108.249" }, "countryCode2": { "type": "string", "example": "CY" }, "countryCode3": { "type": "string", "example": "CYP" }, "city": { "type": "string", "example": "Nicosia" }, "lat": { "type": "integer", "example": 600, "default": 0 }, "lon": { "type": "integer", "example": 700, "default": 0 }, "asn": { "type": "integer", "example": 6866, "default": 0 }, "asnOrg": { "type": "string", "example": "Cyprus Telecommunications Authority" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "cpDevUA" }, "sessionId": { "type": "string", "example": "cpDevSess" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "cpDevFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "cpInstCode" }, "name": { "type": "string", "example": "cpInstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PAN" } } }, "internalId": { "type": "string", "example": "vaspInternalId" } } } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "nYnHx" }, "attemptId": { "type": "string", "example": "LMkcV" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 139, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 139, "default": 0 }, "createDate": { "type": "string", "example": "2024-05-06 13:10:23+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-05-06 13:10:23+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 0, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "CRYPTO/CRYSTAL IN TXN", "type": "object", "properties": { "id": { "type": "string", "example": "6638d6bf26d0f119b6fbd5f0" }, "applicantId": { "type": "string", "example": "6638d4fea34063225deb5886" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "Crypto0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "crypto0001" }, "txnDate": { "type": "string", "example": "2024-04-04 10:50:00+0000" }, "type": { "type": "string", "example": "finance" }, "info": { "type": "object", "properties": { "paymentTxnId": { "type": "string", "example": "txnHash" }, "type": { "type": "string", "example": "customType" }, "direction": { "type": "string", "example": "in" }, "amount": { "type": "integer", "example": 10, "default": 0 }, "currencyCode": { "type": "string", "example": "BTC" }, "currencyType": { "type": "string", "example": "crypto" }, "amountInDefaultCurrency": { "type": "number", "example": 588235.2941176471, "default": 0 }, "defaultCurrencyCode": { "type": "string", "example": "EUR" }, "paymentDetails": { "type": "string", "example": "InfoDetails" } } }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "Crypto0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "crypto" }, "accountId": { "type": "string", "example": "usersWalletAddress" }, "issuingCountry": { "type": "string", "example": "CAN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "countryCode2": { "type": "string", "example": "PL" }, "countryCode3": { "type": "string", "example": "POL" }, "city": { "type": "string", "example": "Zhytkavichy" }, "zipCode": { "type": "string", "example": "225749" }, "lat": { "type": "integer", "example": 300, "default": 0 }, "lon": { "type": "integer", "example": 500, "default": 0 }, "asn": { "type": "integer", "example": 6697, "default": 0 }, "asnOrg": { "type": "string", "example": "Republican Unitary Telecommunication Enterprise Poltelecom" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "InstCode" }, "name": { "type": "string", "example": "InstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PRT" } } } } } } }, "counterparty": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "cpExtId" }, "fullName": { "type": "string", "example": "CP Name" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "cpBuildingName" }, "flatNumber": { "type": "string", "example": "303" }, "subStreet": { "type": "string", "example": "cpSubStreet" }, "subStreetEn": { "type": "string", "example": "cpSubStreetEn" }, "street": { "type": "string", "example": "cpStreet" }, "streetEn": { "type": "string", "example": "cpStreetEn" }, "state": { "type": "string", "example": "cpState" }, "stateEn": { "type": "string", "example": "cpStateEn" }, "buildingNumber": { "type": "string", "example": "404" }, "town": { "type": "string", "example": "cpTown" }, "townEn": { "type": "string", "example": "cpTownEn" }, "postCode": { "type": "string", "example": "987654" }, "country": { "type": "string", "example": "QAT" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "crypto" }, "accountId": { "type": "string", "example": "cpWalletAddress" }, "issuingCountry": { "type": "string", "example": "SVN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "62.228.108.249" }, "countryCode2": { "type": "string", "example": "CY" }, "countryCode3": { "type": "string", "example": "CYP" }, "city": { "type": "string", "example": "Nicosia" }, "lat": { "type": "integer", "example": 600, "default": 0 }, "lon": { "type": "integer", "example": 700, "default": 0 }, "asn": { "type": "integer", "example": 6866, "default": 0 }, "asnOrg": { "type": "string", "example": "Cyprus Telecommunications Authority" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "cpDevUA" }, "sessionId": { "type": "string", "example": "cpDevSess" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "cpDevFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "cpInstCode" }, "name": { "type": "string", "example": "cpInstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PAN" } } }, "internalId": { "type": "string", "example": "vaspInternalId" } } } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "nYnHx" }, "attemptId": { "type": "string", "example": "LMkcV" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 139, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 139, "default": 0 }, "createDate": { "type": "string", "example": "2024-05-06 13:10:23+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-05-06 13:10:23+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 0, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "FIAT OUT", "type": "object", "properties": { "id": { "type": "string", "example": "663b3883f882642c48f43af0" }, "applicantId": { "type": "string", "example": "663b3883f882642c48f43aea" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "Finance0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "finance0001" }, "txnDate": { "type": "string", "example": "2024-04-04 10:50:00+0000" }, "type": { "type": "string", "example": "finance" }, "info": { "type": "object", "properties": { "type": { "type": "string", "example": "CustomTxnType" }, "direction": { "type": "string", "example": "out" }, "amount": { "type": "integer", "example": 1000, "default": 0 }, "currencyCode": { "type": "string", "example": "EUR" }, "currencyType": { "type": "string", "example": "fiat" }, "amountInDefaultCurrency": { "type": "integer", "example": 1000, "default": 0 }, "defaultCurrencyCode": { "type": "string", "example": "EUR" }, "paymentDetails": { "type": "string", "example": "InfoDetails" } } }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "Finance0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "dob": { "type": "string", "example": "1995-09-30" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "card" }, "accountId": { "type": "string", "example": "usersWalletAddress" }, "issuingCountry": { "type": "string", "example": "CAN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "countryCode2": { "type": "string", "example": "PL" }, "countryCode3": { "type": "string", "example": "POL" }, "city": { "type": "string", "example": "Zhytkavichy" }, "zipCode": { "type": "string", "example": "225749" }, "lat": { "type": "integer", "example": 300, "default": 0 }, "lon": { "type": "integer", "example": 500, "default": 0 }, "asn": { "type": "integer", "example": 6697, "default": 0 }, "asnOrg": { "type": "string", "example": "Republican Unitary Telecommunication Enterprise Poltelecom" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "InstCode" }, "name": { "type": "string", "example": "InstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PRT" } } } } } } }, "counterparty": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "cpExtId" }, "fullName": { "type": "string", "example": "CP Name" }, "dob": { "type": "string", "example": "1995-09-30" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "cpBuildingName" }, "flatNumber": { "type": "string", "example": "303" }, "subStreet": { "type": "string", "example": "cpSubStreet" }, "subStreetEn": { "type": "string", "example": "cpSubStreetEn" }, "street": { "type": "string", "example": "cpStreet" }, "streetEn": { "type": "string", "example": "cpStreetEn" }, "state": { "type": "string", "example": "cpState" }, "stateEn": { "type": "string", "example": "cpStateEn" }, "buildingNumber": { "type": "string", "example": "404" }, "town": { "type": "string", "example": "cpTown" }, "townEn": { "type": "string", "example": "cpTownEn" }, "postCode": { "type": "string", "example": "987654" }, "country": { "type": "string", "example": "QAT" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "cpPayType" }, "accountId": { "type": "string", "example": "cpPayAccId" }, "issuingCountry": { "type": "string", "example": "SVN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "countryCode3": { "type": "string", "example": "SJM" }, "lat": { "type": "integer", "example": 600, "default": 0 }, "lon": { "type": "integer", "example": 700, "default": 0 }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "cpDevUA" }, "sessionId": { "type": "string", "example": "cpDevSess" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "cpDevFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "cpInstCode" }, "name": { "type": "string", "example": "cpInstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PAN" } } } } } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "vlMRF" }, "attemptId": { "type": "string", "example": "oANbQ" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 24, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 24, "default": 0 }, "createDate": { "type": "string", "example": "2024-05-08 08:32:03+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-05-08 08:32:03+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 0, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } }, { "title": "FIAT IN", "type": "object", "properties": { "id": { "type": "string", "example": "663b3883f882642c48f43af0" }, "applicantId": { "type": "string", "example": "663b3883f882642c48f43aea" }, "scope": { "type": "string", "example": "events" }, "externalUserId": { "type": "string", "example": "Finance0001" }, "clientId": { "type": "string", "example": "korban.inc" }, "data": { "type": "object", "properties": { "txnId": { "type": "string", "example": "finance0001" }, "txnDate": { "type": "string", "example": "2024-04-04 10:50:00+0000" }, "type": { "type": "string", "example": "finance" }, "info": { "type": "object", "properties": { "type": { "type": "string", "example": "CustomTxnType" }, "direction": { "type": "string", "example": "in" }, "amount": { "type": "integer", "example": 1000, "default": 0 }, "currencyCode": { "type": "string", "example": "EUR" }, "currencyType": { "type": "string", "example": "fiat" }, "amountInDefaultCurrency": { "type": "integer", "example": 1000, "default": 0 }, "defaultCurrencyCode": { "type": "string", "example": "EUR" }, "paymentDetails": { "type": "string", "example": "InfoDetails" } } }, "applicant": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "Finance0001" }, "fullName": { "type": "string", "example": "Users Fullname" }, "dob": { "type": "string", "example": "1995-09-30" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "usersAddBuildName" }, "flatNumber": { "type": "string", "example": "101" }, "subStreet": { "type": "string", "example": "usersAddSbSt" }, "subStreetEn": { "type": "string", "example": "usersAddSbStEn" }, "street": { "type": "string", "example": "usersAddSt" }, "streetEn": { "type": "string", "example": "usersAddStEn" }, "state": { "type": "string", "example": "usersAddState" }, "stateEn": { "type": "string", "example": "usersAddStateEn" }, "buildingNumber": { "type": "string", "example": "202" }, "town": { "type": "string", "example": "usersAddressTown" }, "townEn": { "type": "string", "example": "usersAddressTownEn" }, "postCode": { "type": "string", "example": "123456" }, "country": { "type": "string", "example": "CAN" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "card" }, "accountId": { "type": "string", "example": "usersWalletAddress" }, "issuingCountry": { "type": "string", "example": "CAN" } } }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "countryCode2": { "type": "string", "example": "PL" }, "countryCode3": { "type": "string", "example": "POL" }, "city": { "type": "string", "example": "Zhytkavichy" }, "zipCode": { "type": "string", "example": "225749" }, "lat": { "type": "integer", "example": 300, "default": 0 }, "lon": { "type": "integer", "example": 500, "default": 0 }, "asn": { "type": "integer", "example": 6697, "default": 0 }, "asnOrg": { "type": "string", "example": "Republican Unitary Telecommunication Enterprise Poltelecom" }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "usersDeviceUA" }, "sessionId": { "type": "string", "example": "usersDeviceSesId" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "usersDeviceFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "InstCode" }, "name": { "type": "string", "example": "InstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PRT" } } } } } } }, "counterparty": { "type": "object", "properties": { "externalUserId": { "type": "string", "example": "cpExtId" }, "fullName": { "type": "string", "example": "CP Name" }, "dob": { "type": "string", "example": "1995-09-30" }, "placeOfBirth": { "type": "string", "example": "settlementName" }, "address": { "type": "object", "properties": { "buildingName": { "type": "string", "example": "cpBuildingName" }, "flatNumber": { "type": "string", "example": "303" }, "subStreet": { "type": "string", "example": "cpSubStreet" }, "subStreetEn": { "type": "string", "example": "cpSubStreetEn" }, "street": { "type": "string", "example": "cpStreet" }, "streetEn": { "type": "string", "example": "cpStreetEn" }, "state": { "type": "string", "example": "cpState" }, "stateEn": { "type": "string", "example": "cpStateEn" }, "buildingNumber": { "type": "string", "example": "404" }, "town": { "type": "string", "example": "cpTown" }, "townEn": { "type": "string", "example": "cpTownEn" }, "postCode": { "type": "string", "example": "987654" }, "country": { "type": "string", "example": "QAT" }, "formattedAddress": { "type": "string", "example": "postCode, town, state, street, buildingNumber" } } }, "type": { "type": "string", "example": "individual" }, "paymentMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "cpPayType" }, "accountId": { "type": "string", "example": "cpPayAccId" }, "issuingCountry": { "type": "string", "example": "SVN" } } }, "paymentMethodExtractedInfo": { "type": "object", "properties": { "type": { "type": "string", "example": "smartContract" } } }, "device": { "type": "object", "properties": { "ipInfo": { "type": "object", "properties": { "ip": { "type": "string", "example": "178.123.68.138" }, "countryCode3": { "type": "string", "example": "SJM" }, "lat": { "type": "integer", "example": 600, "default": 0 }, "lon": { "type": "integer", "example": 700, "default": 0 }, "riskyAsn": { "type": "boolean", "example": false, "default": true } } }, "userAgent": { "type": "string", "example": "cpDevUA" }, "sessionId": { "type": "string", "example": "cpDevSess" }, "sessionAgeMs": { "type": "integer", "example": 18, "default": 0 }, "acceptLang": { "type": "string", "example": "en" }, "fingerprint": { "type": "string", "example": "cpDevFing" } } }, "institutionInfo": { "type": "object", "properties": { "code": { "type": "string", "example": "cpInstCode" }, "name": { "type": "string", "example": "cpInstName" }, "address": { "type": "object", "properties": { "country": { "type": "string", "example": "PAN" } } } } } } }, "props": { "type": "object", "properties": { "customProperty": { "type": "string", "example": "Custom value" }, "dailyOutLimit": { "type": "string", "example": "10000" } } } } }, "score": { "type": "integer", "example": 0, "default": 0 }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "vlMRF" }, "attemptId": { "type": "string", "example": "oANbQ" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 24, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 24, "default": 0 }, "createDate": { "type": "string", "example": "2024-05-08 08:32:03+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "createdAt": { "type": "string", "example": "2024-05-08 08:32:03+0000" }, "scoringResult": { "type": "object", "properties": { "score": { "type": "integer", "example": 0, "default": 0 }, "dryScore": { "type": "integer", "example": 0, "default": 0 }, "matchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "unmatchedRules": { "type": "array", "items": { "type": "object", "properties": {} } }, "action": { "type": "string", "example": "score" }, "ruleCnt": { "type": "integer", "example": 0, "default": 0 }, "dryRunRuleCnt": { "type": "integer", "example": 0, "default": 0 }, "tagScores": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "typedTags": { "type": "array", "items": { "type": "object", "properties": {} } }, "txnInactive": { "type": "boolean", "example": false, "default": true } } } ] } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```