RegularizeTravelRuleOneStepResponse
- Schema
- Example
addressRiskLevel
RequiredString
address risk level is provided from GTR, the enum of risk level: low, medium, high. (*Please mind this feature is for reference, this is not mandatory to reject any transaction)
Example
high
beneficiaryVasp
RequiredString
perspective of money transfer direction, beneficiary means who receive the money
Example
(GTR VASP Code)
encryptedPayload
OptionalString
Min Length1
Max Length60000
initiatorPublicKey
RequiredString
initiatorPublicKey here is your public key
Example
0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=
originatorVasp
RequiredString
perspective of money transfer direction, originator means who send the money
Example
(GTR VASP Code)
[+]piiSecuredInfo
RequiredObject
PiiSecuredInfo
Example
(Refer to inner structure)
preflightCheckMessage
OptionalString
preflight check message is to let you know whether the counter-party vasp will accept your request or not *This is only suitable in before-on-chain scenario. *And also not mandatory for check the result of pre-flight
Example
(ANY MESSAGE)
preflightCheckStatus
OptionalString
PreflightCheckStatusEnum
Example
ACCEPTED
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
targetVaspCode
RequiredString
targetVaspCode here is the counter-party VASP that you want to send the travel rule request (*Not the assets transfer direction), vaspCode is GTR system's format
Example
MAkGAda4ac
targetVaspPublicKey
RequiredString
targetVaspPublicKey is the counter-party VASP's public key in Curve25519, you can get this public key by vaspDetail api or vaspList api. *If you're using newest version, please mind that this field is for curve25519 format-key, using PiiSecuredInfo structure, but also fill the value same as piiSecuredInfo here
Example
0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=
[+]verifiedFields
RequiredArray<Object>
the verified fields
Example
[
{
"type": "111001",
"status": 1,
"message": "beneficiary legal person name match"
},
{
"type": "110026",
"status": 2,
"message": "beneficiary natural person name mismatch"
},
{
"type": "110025",
"status": 2,
"message": "beneficiary natural person date of birth mismatch"
}
]
{
"encryptedPayload": "string",
"beneficiaryVasp": "(GTR VASP Code)",
"requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
"initiatorPublicKey": "0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=",
"verifiedFields": "[\n {\n \"type\": \"111001\",\n \"status\": 1,\n \"message\": \"beneficiary legal person name match\"\n },\n {\n \"type\": \"110026\",\n \"status\": 2,\n \"message\": \"beneficiary natural person name mismatch\"\n },\n {\n \"type\": \"110025\",\n \"status\": 2,\n \"message\": \"beneficiary natural person date of birth mismatch\"\n }\n]",
"originatorVasp": "(GTR VASP Code)",
"piiSecuredInfo": "(Refer to inner structure)",
"preflightCheckStatus": "ACCEPTED",
"addressRiskLevel": "high",
"preflightCheckMessage": "(ANY MESSAGE)",
"targetVaspCode": "MAkGAda4ac",
"targetVaspPublicKey": "0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ="
}