Skip to main content
Search

RegularizeCallbackVerifyPIIRequest

address
RequiredString
address is beneficiary address (in all scenario)
Min Length1
Max Length256
Example
E9aX7TbJqvLwzC1f8rYpBnGks3M0QHjVxODUZ_WRmT2yXoLp
amount
RequiredString
amount is corresponding to the ticker, the amount of the coin in this transfer, this amount should be string (Reference: Longest AVAX should be decimal(28,18) / numeric(28,18))
Min Length0
Max Length64
Example
0.000000000000000008
beneficiaryVasp
RequiredString
perspective of money transfer direction, beneficiary means who receive the money
Min Length0
Max Length32
Example
(GTR VASP Code)
beneficiaryVaspName
RequiredString
perspective of money transfer direction, beneficiary means who receive the money
Min Length0
Max Length128
Example
(GTR VASP Name)
fiatName
RequiredString
fiatName is the currency unit of equality amount of coin, should convert to stable coin (USDT, EURC, USDC...etc) / real world fiat currency like (USD, EUR, NZD, GBP, HKD, CNY, JPY, TRY...etc), please prior to choose fiat currency.
Min Length0
Max Length64
Example
USD
fiatPrice
RequiredString
fiatPrice is the equality amount of coin, the price ratio is always changing, just make sure you convert when the time you initiate the request.
Min Length0
Max Length64
Example
84.12
initiatorExpectVerifyFields
OptionalArray<String>
The PII Info that you expect to be verify, GTR will matches the results if the targetVasp has verified. The verify type code has distinguish by different direction like Originator and Beneficiary. The PII Type code can refer to:
Example
["110026", "110025", "110045", "100031"] *(110026: Beneficiary Natural Person Name, 110025: Beneficiary Natural Person Date of Birth, 110045: Beneficiary Natural Person National ID, 100031: Originator Natural Person Address Lines),
initiatorVasp
RequiredString
the vasp who initiate this request
Min Length0
Max Length32
Example
[vaspCode]
network
RequiredString
Network name in short symbol, the reference can check the table.
Min Length0
Max Length64
Example
XRP
originatorVasp
RequiredString
perspective of money transfer direction, originator means who send the money
Min Length0
Max Length32
Example
(GTR VASP Code)
originatorVaspName
RequiredString
perspective of money transfer direction, originator means who send the money
Min Length0
Max Length128
Example
(GTR VASP Name)
[+]piiSecuredInfo
RequiredObject
PiiSecuredInfo
Example
(Refer to inner structure)
receiverVasp
RequiredString
the vasp who will receive this request
Min Length0
Max Length32
Example
[vaspCode]
requestId
RequiredString
requestId is the unique id for all transaction, the same travelrule-request invoke process flow should be using same requestId, the recommend format is: "[YOUR_VASP_NAME]-[UUIDv4]"
Min Length4
Max Length64
Pattern
[\w\d_=-]+
Example
testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5
tag
OptionalString
some of network like XRP required to input address tag (memo)
Min Length0
Max Length64
Example
466489710
ticker
RequiredString
ticker (coin) is the symbol of coin money, could refer to CMC
Min Length0
Max Length64
Example
USDT
txId
RequiredString
*if the travel rule is after on chain, then the txId is required. the tx id format type can check the table.
Min Length0
Max Length256
Example
d1029841dacb031098288b257b628a967eb963bbaccf954506ad0694219497a4
verificationDirection
RequiredInteger (int32)
direction is travelrule direction. verifyDirection: 1 (After On Chain), verifyDirection: 2 (Before On Chain), Perspective if from your system, 1 means you're Beneficiary that receive funds, and you send the Originator KYC/B (IVMS) to check, 2 means you're Originator that you want to send the funds, and you send the Beneficiary KYC/B (IVMS) to check.
verifyMessage
OptionalString
Min Length0
Max Length4096
verifyStatus
OptionalInteger (int32)