Initiate SDK for Travel Rule transaction

Overview

Use this method to initiate the Travel Rule SDK, allowing the user to submit all required fields for a Travel Rule transaction.

Upon a successful request, the system will generate a token and a WebSDK link. If the Travel Rule is not applicable to the transaction, the system will return an error response.

📘

Note

The generated token can be used for WebSDK integration.

Request example

curl -X POST \
     'https://api.sumsub.com/resources/tr/sdk/init' \
     -H 'accept: application/json' \
     -H 'content-type: application/json' \
     -d '{
            "userId": "n7v2lu8civ2j2vkau",
            "txnInfo": {
              "applicantWalletAddress" : "0x611Fb08528080848Dd3439242fdfg993d18ADd95dsd",
              "counterpartyWalletAddress" : "0x611Fb08528080848Dd3439242fdfg993d18ADd95dsd",
              "amount": 10,
              "currencyCode": "ETH",
              "cryptoChain" : "", // Required for non-native tokens.
              "direction": "out"
            },
            "ttlInSecs": "1800",
            "levelName": "level-name"
         }'

Response explained

The response is a JSON file that includes a token and a WebSDK link that you can send to a user.

Response examples

If the request is successfully sent and processed, you will get a response like the one below.

{
  "token": "_act-c876fb50-1564-495e-a3ad-49b97cf679d2-v2",
  "link": "http://localhost:8092/websdk/p/Lrn2A2dACbpuoWOD",
  "ttlInSecs": 1800
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

{
  "code": 403,
  "correlationId": "a5727da745d21b4dcf46fa0e02c708b2",
  "errorCode": 0,
  "description": "You don't have this feature enabled, please contact us"
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!