API Reference
API ReferenceChangelogFAQDashboard

Submit transaction for non-existing applicant

post https://api.sumsub.com/resources/applicants/-/kyt/txns/-/data

Overview

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

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

For more information about the default TM integration flow, see here.

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.

{
  "txnId": "general0001",  // Required. Unique transaction identifier.
  "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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).
      "platform": "macOS"  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
    }
  },
  "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.
    "failure": true  // Result received within an event, where 'true' stands for 'completed', 'false' — 'not completed'.
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "twoFaReset0001",  // Required. Unique transaction identifier.
  "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": "Users Fullname",  // Required. Full name of the transaction's participant.
    "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).
      "platform": "macOS"  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
    }
  },
  "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.
    "failure": true  // A result received within an event, where 'true' stands for 'completed', 'false' — 'not completed'.
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "passwordReset0001",  // Required. A unique transaction identification number.
  "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": "Users Fullname",  // Required. Full name of the transaction participant
    "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).
      "platform": "macOS"  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
    }
  },
  "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.
    "failure": true  // A result received within an event, where 'true' stands for 'completed', 'false' — 'not completed'.
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "login0001",  // Required. Unique transaction identifier.
  "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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).
      "platform": "macOS"  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
    }
  },
  "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.
    "failure": true  // Result received within an event, where 'true' stands for 'completed', 'false' — 'not completed'.
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "SingUp0001",  // Required. Unique transaction identifier.
  "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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).
      "platform": "macOS"  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
    }
  },
  "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.
    "failure": true  // Result received within an event, where 'true' stands for 'completed', 'false' — 'not completed'.
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "crypto0001",  // Required. Unique transaction identifier.
  "txnDate": "2024-04-04 13:50:00+0300",  // Date and time of performing the transaction.  
  "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",  // Text written by the user within the transaction.
    "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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.
      "address": {  // Transaction institution address.
        "country": "PRT"  // Transaction institution country. Presented in Alpha-3 code.
      },
      "code": "BIC",  //  Transaction institution code (e.g. BIC).
      "name": "Wells Fargo",  // Transaction 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": {  // Information about the payment method used within the transaction.
      "type": "crypto",  // Payment method type, e.g. 'card', 'bank account', 'crypto'.
      "accountId": "usersWalletAddress",  // 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "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": "CP Name",  // Full name of the transaction participant (applicant or counterparty).
    "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.
      "address": {  // Transaction institution address.
        "country": "PAN"  // Transaction institution country. Presented as Alpha-3 code.
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo",  // Transaction 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "fingerprint": "cpDevFing"  // Device fingerprint.
    }
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "crypto0001",  // Required. Unique transaction identifier.
  "txnDate": "2024-04-04 13:50:00+0300",  // Date and time of performing the transaction.
  "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",  // Text written by the user within the transaction.
    "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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.
      "address": {  // Transaction institution address.
        "country": "PRT"  // Transaction institution country. Presented in Alpha-3 code
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo",  // Transaction 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": {  // Information about the payment method used within the transaction.
      "type": "crypto",  // Payment method type, e.g. 'card', 'bank account', 'crypto'.
      "accountId": "usersWalletAddress",  // 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "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": "CP Name"  // Full name of the transaction participant (applicant or counterparty).
    "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.
      "address": {  // Transaction institution address.
        "country": "PAN"  // Transaction institution country. Presented in Alpha-3 code.
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo",  // Transaction 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "fingerprint": "cpDevFing"  // Device fingerprint.
    }
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "bgi47c04whc43ra2skg8bv",  // Required. A unique transaction identification number.
  "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" // Comment with payment details.
  },  
  "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).
    "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).
    "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.
    }    
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "7hjyiypvs89ewbcv9p0ojj",  // Required. Unique transaction identification number.
  "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"  // Comment with payment details.
  },  
  "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 Smit",   // Required. Full name of the transaction participant (applicant or counterparty).
    "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.
    }    
  },
  "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).
    "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.
  }
}

{
  "txnId": "finance0001",  // Required. Unique transaction identifier.
  "txnDate": "2024-04-04 13:50:00+0300",  // Date and time of performing the transaction.  
  "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",  // Text written by the user within the transaction.
    "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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.
      "address": {  // Transaction institution address.
        "country": "PRT"  // Transaction institution country. Presented in Alpha-3 code.
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo"  // Transaction institution 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": "usersWalletAddress",  // 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 the online session (e.g. eng).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "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).
    "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.
      "address": {  // Transaction institution address.
        "country": "PAN"  // Transaction institution country.
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo"  // Transaction 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "fingerprint": "cpDevFing"  // Device fingerprint.
    }
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "finance0001",  // Required. Unique transaction identification number.
  "txnDate": "2024-04-04 13:50:00+0300",  // Date and time of performing the transaction.
  "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",  // Text written by the user within the transaction.
    "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": "Users Fullname",  // Required. Full name of the transaction participant.
    "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.
      "address": {  // Transaction institution address.
        "country": "PRT"  // Transaction institution country.
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo"  // Transaction 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": "usersWalletAddress",  // 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 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "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": "CP Name",  // Full name of the transaction participant (applicant or counterparty).        
    "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.
      "address": {  // Transaction institution address.
        "country": "PAN"  // Transaction institution country.
      },
      "code": "BIC",  // Transaction institution code (e.g. BIC).
      "name": "Wells Fargo"  // Transaction 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).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "fingerprint": "cpDevFing"  // Device fingerprint.
    }
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}

{
  "txnId": "TravelRuleTest0007",  // Required. Unique transaction identifier.
  "txnDate": "2024-04-25 15:08:51+0300",  // Date and time of performing the transaction.
  "type": "travelRule",  // 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.
    "type": "ExampleCategory",   // A string for categorizing transactions.
    "cryptoParams": {  // Includes crypto transaction parameters.
      "cryptoChain": "ETH"  // Optional, only needed when the asset is on a non-native chain.
    },
    "paymentTxnId": "ExampleHash"  // Required for a crypto check. Unique identifier that is used to monitor a transaction on the blockchain.
  },  
  "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": "IdFromYourSystem0001",  // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system.    
    "fullName": "TravelRule Person",  // Full name of the transaction participant.
    "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.
    },
    "paymentMethod": {  // Information about the payment method used within the transaction.
      "type": "bank account",  // Payment method type, e.g. 'card', 'bank account', 'crypto'.
      "accountId": "UsersWalletAddress0001",  // 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 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": 100,  // Session lifetime in milliseconds.
      "acceptLang": "en",  // Language used during the online session (e.g. eng).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "fingerprint": "AppDevFing"  // Device fingerprint.
    },
    "institutionInfo": {  // Information about the financial institution engaged in performing this transaction.
      "internalId": "661d150d075ac53ae9129258"  // VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval.
    }
  },
  "counterparty": {  // Required object. Information about the sender/receiver depending on the transaction direction.
    "type": "individual",  // Required. Participant entity type — company or individual. The ‘individual’ is set by default.
    "externalUserId": "wru1tc63m0jhctaoejboim",   // Required. Unique identifier of the transaction participant (applicant or counterparty) in your system.    
    "fullName": "Reciever's FullName",  // Required. Full name of the transaction participant.
    "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.
    },
    "paymentMethod": {  // Required object. Information about the payment method used within the transaction.
      "type": "bank account",  // Payment method type, e.g. 'card', 'bank account', 'crypto'.
      "accountId": "RecieverWalletAddress0001",   // 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": "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": 100,  // Session lifetime in milliseconds.
      "acceptLang": "en",  // Language used during the online session (e.g. eng).
      "platform": "macOS",  // Device platform used during the online session (e.g. Android, iOS, Windows, macOS, Linux).
      "fingerprint": "cpDevFing"  // Device fingerprint.
    },
    "institutionInfo": {  // Information about the financial institution engaged in performing this transaction.
      "internalId": "661d1525075ac53ae9129263"   // VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval.
    }
  },
  "props": { // Custom properties.
    "customProperty": "Custom value that can be used in rules",  // 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.

Errors explained

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

{
  "description": "Entity already exists",
  "code": 409
}

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

{
  "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.
{
      "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:

"applicant": {  
    "type": "individual",  
    "externalUserId": "PlatformEvent0001",  
    "fullName": "User fullname"  
}

{
    "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.

{
  "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.

{
  "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).

{
  "description": "App token is invalid",
  "code": 401,
  "errorCode": 4002,
  "errorName": "app-token-private-part-mismatch"
}

Check the correctness of the used app token.

{
  "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.

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