Get PII Verified Notify

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(pii_verified_notify: 15)

This callback API endpoint receives notifications about manual PII verification results. When the receiver completes their verification, GTR notifies your service with the result.

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

	Property	Type	Required	Description
	notifyResult	Object	No
Property Type Description verifyMessage String verifyStatus Integer
	piiSecuredInfo	Object	No
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
	piiVerifyResult	Object	No
Property Type Description verifiedFields Array<Object> Property Type Description [*].message String message of match [*].status Integer VerifyFieldStatus [*].type String IvmsFieldEnum
	preflightCheckResult	Object	No
Property Type Description preflightCheckMessage String preflightCheckStatus String
	travelruleInfo	Object	No
Property Type Description initiatorVaspCode String receiverVaspCode String requestId String verificationDirection Integer

Example

{
  "travelruleInfo": {
    "initiatorVaspCode": "string",
    "requestId": "string",
    "receiverVaspCode": "string",
    "verificationDirection": 0
  },
  "notifyResult": {
    "verifyStatus": 0,
    "verifyMessage": "string"
  },
  "piiVerifyResult": {
    "verifiedFields": [
      {
        "message": "string",
        "type": "110026",
        "status": 1
      }
    ]
  },
  "preflightCheckResult": {
    "preflightCheckStatus": "string",
    "preflightCheckMessage": "string"
  },
  "piiSecuredInfo": {
    "piiSpecVersion": "ivms101-2020",
    "secretAlgorithm": "ecies_secp256r1",
    "receiverKeyInfo": "(Refer to inner structure)",
    "initiatorKeyInfo": "(Refer to inner structure)",
    "securedPayload": "(base64 or other format's encrypted raw text)",
    "encryptionParams": "(Refer to inner structure)",
    "piiSecretFormatType": "FULL_JSON_OBJECT_ENCRYPT"
  }
}

Responses

Status 200

OK

JSON Content

Schema

	Property	Type	Description
	verifyMessage	String
	verifyStatus	Integer

Example

{
  "verifyStatus": 0,
  "verifyMessage": "string"
}

Status HTTP Status: 200, VerifyStatus: 100000

JSON Content

Schema

	Property	Type	Description
	data	Object
Property Type Description No properties
	verifyMessage	String
	verifyStatus	Integer

Example

{
  "data": {},
  "verifyStatus": 0,
  "verifyMessage": "string"
}