Skip to main content
POST
/
widgets
/
travel-rule
/
sessions
Create session
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/widgets/travel-rule/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "flow": "withdrawal-form",
  "data": {
    "quoteId": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0"
  }
}'
{
  "session": {
    "flow": "withdrawal-form",
    "url": "https://travel-rule.enterprise.uphold.com/",
    "token": "GEbRxBN...edjnXbL",
    "data": {
      "formParameters": {
        "authToken": "eyJhbGciOiJIUzI1NiJ9.eyJJc3N1ZXIiOiJJc3N1ZXIiLCJleHAiOjE3NjA2MDgzNDAsImlhdCI6MTc2MDYwODM0MH0.11CrOdh3aey9kWbgGAA8i9_f9LZl5hLJyiko6oX8QoM",
        "nodeUrl": "https://api.notabene.dev",
        "nonCustodialDeclarationType": "DECLARATION",
        "options": {
          "allowedAgentTypes": [
            "WALLET",
            "VASP"
          ],
          "allowedCounterpartyTypes": [
            "natural",
            "legal",
            "self"
          ],
          "counterpartyAssist": false,
          "proofs": {
            "fallbacks": [
              "self-declaration",
              "screenshot"
            ],
            "reuseProof": true
          },
          "vasps": {
            "addUnknown": true
          }
        },
        "transactionTypeAllowed": "ALL",
        "vaspDid": "did:ethr:0xeab8c4b66bacc1095a8d7b3421d30d4e5a6b8109",
        "widget": "https://beta-widget.notabene.dev"
      },
      "quote": {
        "id": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
        "amount": "5.436328",
        "amountInLowestUnit": 5436328,
        "asset": "XRP",
        "beneficiaryAddress": "rBUN3thXZqVk7czm8huFaahNkL4LMByATd"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.0

Body

application/json
flow
enum<string>
required

The flow of the travel rule widget session.

Available options:
withdrawal-form
data
object
required

The data for the travel rule withdrawal form flow.

Response

Session created.

session
object
required