Skip to content
API Vasp
/
/
Initiate

Overview

Originator/Beneficiary entry points

OpenVasp specification v.3.2.1

Download OpenAPI description
vasp.json
vasp.yaml
Languages
Servers
Production
https://trp.travel-rule.com

Identity

Operations

Auth

Operations

Address

Operations

Transfer

Operations

Initiate

Request

Initiates a Travel Rule transfer by submitting the full IVMS101 originator and beneficiary profiles along with the transaction details. This endpoint returns a TRP transferId and triggers status callbacks to the originator VASP. Required to begin compliant cross-VASPs transfers.

Security
BearerAuth
Bodyapplication/json
travelAddressstring[ 1 .. 255 ]
Example: "taCFLQmuE6GqfR2jRM6m8qF7b9V8PjhzGiED4KmteccXagHRPKVDbLSKe9MwF755NJuKL5Q1CJ1zmXDm2m7crZBUJ7pPfDCoKL1n"
emailstring<= 255
txIdstring<= 255
assetstring<= 20required
Example: "USDT"
amountstring<= 50required
Example: "1000"
callbackstring[ 1 .. 255 ]required
Example: "https://webhook.site"
originatorobjectrequired
Example: {"personType":"natural","firstName":"John","lastName":"Doe","dateOfBirth":"1990-01 15","addressType":"HOME","streetName":"Main Street","buildingNumber":"123","postCode":"10001","townName":"New York","country":"US","nationalId":"123456789","nationalIdType":"ARNU","accountNumber":"ACC123456","walletAddress":"00xWE2erfg234234dssdflkjSDFSDF2"}
originator.​personTypestringrequired
Example: "natural"
originator.​firstNamestringrequired
Example: "John"
originator.​lastNamestringrequired
Example: "Doe"
originator.​dateOfBirthstringrequired
Example: "1990-01 15"
originator.​addressTypestring
Example: "HOME"
originator.​streetNamestring
Example: "Main Street"
originator.​buildingNumberstring
Example: "123"
originator.​postCodestring
Example: "10001"
originator.​townNamestring
Example: "New York"
originator.​countrystring= 2 characters
Example: "US"
originator.​nationalIdstring
Example: "123456789"
originator.​nationalIdTypestring
Example: "ARNU"
originator.​accountNumberstring
Example: "ACC123456"
originator.​walletAddressstring
Example: "00xWE2erfg234234dssdflkjSDFSDF2"
beneficiaryobjectrequired
Example: {"personType":"natural","firstName":"Jane","lastName":"Smith","dateOfBirth":"1985-05 20","addressType":"HOME","streetName":"Oak Avenue","buildingNumber":"456","postCode":"90210","townName":"Los Angeles","country":"US","accountNumber":"ACC789012","walletAddress":"0xsldkjflskdjf123lkjl1kj23gjhguttXXC2"}
beneficiary.​personTypestringrequired
Example: "natural"
beneficiary.​firstNamestringrequired
Example: "Jane"
beneficiary.​lastNamestringrequired
Example: "Smith"
beneficiary.​dateOfBirthstringrequired
Example: "1985-05 20"
beneficiary.​addressTypestring
Example: "HOME"
beneficiary.​streetNamestring
Example: "Oak Avenue"
beneficiary.​buildingNumberstring
Example: "456"
beneficiary.​postCodestring
Example: "90210"
beneficiary.​townNamestring
Example: "Los Angeles"
beneficiary.​countrystring= 2 characters
Example: "US"
beneficiary.​nationalIdstring
beneficiary.​nationalIdTypestring
beneficiary.​accountNumberstring
Example: "ACC789012"
beneficiary.​walletAddressstring
Example: "0xsldkjflskdjf123lkjl1kj23gjhguttXXC2"
curl -i -X POST \
  https://trp.travel-rule.com/transfers/initiate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "travelAddress": "taCFLQmuE6GqfR2jRM6m8qF7b9V8PjhzGiED4KmteccXagHRPKVDbLSKe9MwF755NJuKL5Q1CJ1zmXDm2m7crZBUJ7pPfDCoKL1n",
    "email": "",
    "callback": "https://webhook.site",
    "asset": "USDT",
    "amount": "1000",
    "originator": {
      "personType": "natural",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "1990-01 15",
      "addressType": "HOME",
      "streetName": "Main Street",
      "buildingNumber": "123",
      "postCode": "10001",
      "townName": "New York",
      "country": "US",
      "nationalId": "123456789",
      "nationalIdType": "ARNU",
      "accountNumber": "ACC123456",
      "walletAddress": "00xWE2erfg234234dssdflkjSDFSDF2"
    },
    "beneficiary": {
      "personType": "natural",
      "firstName": "Jane",
      "lastName": "Smith",
      "dateOfBirth": "1985-05 20",
      "addressType": "HOME",
      "streetName": "Oak Avenue",
      "buildingNumber": "456",
      "postCode": "90210",
      "townName": "Los Angeles",
      "country": "US",
      "accountNumber": "ACC789012",
      "walletAddress": "0xsldkjflskdjf123lkjl1kj23gjhguttXXC2"
    }
  }'

Responses

Successful operation

Bodyapplication/json
status"succes" (string) or string
One of:
string("succes")
Response
application/json
{
  "status": "succes"
}

Callbacks

http://client-url.com/events
post

Inquiry Resolution

Request

Inquiry Resolution the unique transfer

Security
BearerAuth
Query
qstringrequired

Query parameter with transfer identifier

Example: q=019b92bd-279e-77aa-9d6f-1bb127798e39
Bodyapplication/json
approvedstringrequired
Example: "7b9V8PjhzGiED4KmteccXagHRPKVDbLSKe9MwF755NJuKL5Q1CJ1zmXDm2m7crZBUJ7pPfDCoKL1n"
callbackstring
Example: "https://webhook.site"
curl -i -X POST \
  'https://trp.travel-rule.com/transfers/inquiryResolution?q=019b92bd-279e-77aa-9d6f-1bb127798e39' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "approved": "7b9V8PjhzGiED4KmteccXagHRPKVDbLSKe9MwF755NJuKL5Q1CJ1zmXDm2m7crZBUJ7pPfDCoKL1n",
    "callback": "https://webhook.site"
  }'

Responses

Successful operation

Bodyapplication/json
statusboolean
Response
application/json
{
  "status": true
}