| addressRiskLevel | String | 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) |
| beneficiaryVasp | String | perspective of money transfer direction, beneficiary means who receive the money |
| encryptedPayload | String | |
| hashSalt | String | |
| initiatorPublicKey | String | initiatorPublicKey here is your public key |
| originatorVasp | String | perspective of money transfer direction, originator means who send the money |
| piiSecuredInfo | Object | PiiSecuredInfo |
| Property | Type | Description |
|---|
| encryptionParams | Object | The parameters for shared encryption/decryption info, it depends to the algorithm type, if no necessary, please leave it blank or empty | | Property | Type | Description |
|---|
| ecies | Object | required if you're using ecies algorithm (ecies_secp384r1_tubitak) should refer to this structure | | Property | Type | Description |
|---|
| ephemeralPublicKey | String | |
|
| | initiatorKeyInfo | Object | initiatorKeyInfo is the direction of Travel Rule Initiator, if you're the initiator, this key should be yours, if you're the receiver (callback server), this is the counter-party VASP's public key that can use to decrypt the PII and encrypt the PII back. | | Property | Type | Description |
|---|
| publicKey | String | publicKey is the key-parameters for encryption according to the selected algorithm. If the key already be base64 like (Curve25519) 0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=, then no need to do anything, the PEM format like (RSA) -----BEGIN CERTIFICATE-----, no need to remove it, keep it and bring out instead. |
| | piiSecretFormatType | String | PiiSecretFormatType | | piiSpecVersion | String | PIISpecVersionType | | receiverKeyInfo | Object | receiverKeyInfo is the direction of Travel Rule Receiver, if you're the initiator, this key must set to the counter-party (targetVasp) VASP's publicKey, if you're the receiver (callback server), this key should be your public key. | | Property | Type | Description |
|---|
| publicKey | String | publicKey is the key-parameters for encryption according to the selected algorithm. If the key already be base64 like (Curve25519) 0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=, then no need to do anything, the PEM format like (RSA) -----BEGIN CERTIFICATE-----, no need to remove it, keep it and bring out instead. |
| | secretAlgorithm | String | AlgorithmType | | securedPayload | String | encrypted payload for PII |
|
| preflightCheckMessage | String | 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 |
| preflightCheckStatus | String | PreflightCheckStatusEnum |
| requestId | String | 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]" |
| secretType | Integer | |
| targetVaspCode | String | 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 |
| targetVaspPublicKey | String | 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 |
| verifiedFields | Array<Object> | the verified fields |
| Property | Type | Description |
|---|
| [*].message | String | message of match | | [*].status | Integer | VerifyFieldStatus | | [*].type | String | IvmsFieldEnum |
|