Skip to main content
Search

RegularizeCallbackVerifyPIIRequest

PropertyTypeRequiredDescription
address
StringNo
addressType
IntegerNo
amount
StringNo
beneficiaryPublicKey
StringNo
beneficiaryVasp
StringNo
beneficiaryVaspName
StringNo
emptyPiiSchema
StringNo
encryptedPayload
StringNo
fiatName
StringNo
fiatPrice
StringNo
hashSalt
StringNo
initiatorExpectVerifyFields
Array<String>No
initiatorPublicKey
StringNo
initiatorVasp
StringNo
network
StringNo
originatorExpectVerifyFields
Array<String>No
originatorPublicKey
StringNo
originatorVasp
StringNo
originatorVaspName
StringNo
piiSecuredInfo
ObjectNo
PropertyTypeDescription
encryptionParams
Object
The parameters for shared encryption/decryption info, it depends to the algorithm type, if no necessary, please leave it blank or empty
PropertyTypeDescription
ecies
Object
required if you're using ecies algorithm (ecies_secp384r1_tubitak) should refer to this structure
PropertyTypeDescription
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.
PropertyTypeDescription
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.
PropertyTypeDescription
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
receiverPublicKey
StringNo
receiverVasp
StringNo
requestId
StringNo
secretType
IntegerNo
tag
StringNo
ticker
StringNo
travelruleId
StringNo
txId
StringNo
verificationDirection
IntegerNo
verifyMessage
StringNo
verifyStatus
IntegerNo