Skip to main content
POST
/
widgets
/
travel-rule
/
sessions
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": "deposit-form", "data": { "requestForInformationId": "a5280aa4-4bff-4f5c-a0a5-0431771b5705" } } '
{ "session": { "flow": "deposit-form", "url": "https://travel-rule.enterprise.uphold.com/", "token": "GEbRxBN...edjnXbL", "data": { "provider": "notabene", "parameters": { "init": { "authToken": "eyJhbGc...6oX8QoM", "nodeUrl": "https://api.notabene.id" }, "options": { "proofs": { "fallbacks": [ "self-declaration" ], "reuseProof": true, "deminimis": { "currency": "EUR", "proofTypes": [], "threshold": 1000 } } }, "transaction": { "amountDecimal": 1.23, "asset": "XRP-XRP", "customer": { "name": "John Doe", "type": "natural" }, "source": [ "rDkjqf1YFGjt39ZrRQu9gMqcNEBmcQaXyC" ] } } } } }

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:
deposit-form
data
object
required

The data for the deposit form flow.

Response

Session created.

session
object
required