Update PII Verify Result

Version: 3.0.0

Method

PUT

Url

https://platform.globaltravelrule.com/api/verify/v2/manual/verify_pii

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

	Property	Type	Required	Description
	requestId	String	Yes	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]"
	result	Object	No
Property Type Description data Object Property Type Description encryptedPayload String hashSalt String initiatorPublicKey String initiatorPublicKey here is your public key 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 receiverPublicKey String receiverPublicKey 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 requestId String secretType Integer verifyFields Array<Object> the verified fields Property Type Description [*].message String message of match [*].status Integer VerifyFieldStatus [*].type String IvmsFieldEnum verifyMessage String Verify message for manual update verify message verifyStatus Integer Verify status for manual update verify status code

Example

{
  "result": {
    "data": {
      "hashSalt": "string",
      "encryptedPayload": "string",
      "verifyFields": "[\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]",
      "requestId": "string",
      "secretType": 0,
      "initiatorPublicKey": "0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=",
      "piiSecuredInfo": "(Refer to inner structure)",
      "preflightCheckStatus": "ACCEPTED",
      "receiverPublicKey": "0szeNNub/IGoe623JCGD4B4bH8I94FozOeZjv1dKlXQ=",
      "preflightCheckMessage": "(ANY MESSAGE)"
    },
    "verifyStatus": 100000,
    "verifyMessage": "Success"
  },
  "requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5"
}

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

Success

JSON Content

Schema

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

Example

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