Initiator Callback API 2 - PII Verification Result Notify
Where should I integrate?
Description
This callback API notifies the initiator VASP about the result of PII verification.
The callback is triggered when the receiving VASP has completed the verification of the provided PII information and needs to inform the initiator about the result.
Note: If you don't have a pending flow in your system, you can skip this implementation.
Timing
- Initiator VASP initiates Travel Rule Request and completes OneStep API's Address/TX Verification
- Receiver VASP responds
pendingto PII Verification - Initiator VASP waits for result from callback
- Receiver VASP invokes this API to notify Initiator VASP of the PII verification results
Callback Payload
Please recognize the callbackType: 15, and save the result to your local service. This is the final callback in the Travel Rule verification process.
{
"callbackType": 15,
"invokeVaspCode": "0xQKGsNzOq2Er-xh6ReiL",
"originatorVasp": "0xQKGsNzOq2Er-xh6ReiL",
"requestId": "[REQUEST-ID]",
"beneficiaryVasp": "gdummy",
"callbackData": {
"notifyResult": {
"verifyMessage": "PII Verification Success",
"verifyStatus": 100006
},
"piiSecuredInfo": {
"initiatorKeyInfo": {
"publicKey": ""
},
"piiSecretFormatType": "FULL_JSON_OBJECT_ENCRYPT",
"piiSpecVersion": "ivms101-2020",
"receiverKeyInfo": {
"publicKey": ""
},
"secretAlgorithm": "ed25519_curve25519",
"securedPayload": "PII"
},
"piiVerifyResult": {
"verifiedFields": [
{}
]
},
"preflightCheckResult": {
"preflightCheckMessage": "",
"preflightCheckStatus": "REJECTED"
},
"travelruleInfo": {
"beneficiaryVaspCode": "gdummy",
"initiatorVaspCode": "0xQKGsNzOq2Er-xh6ReiL",
"invokeVaspCode": "gdummy",
"originatorVaspCode": "0xQKGsNzOq2Er-xh6ReiL",
"receiverVaspCode": "gdummy",
"requestId": "[REQUEST-ID]",
"verificationDirection": 2
}
}
}
Usage
When the Initiator VASP receives the callback of PII verification, you can simply mark your internal record with the stage like: PII Verification via requestId. The actual result refers to callbackData.notifyResult.verifyStatus.
The handling process is basically the same as the response of API calling. You can refer to the same process and take action accordingly.