Update PII Verify Result

Version: 3.0.0

Method

PUT

Url

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

This API endpoint is for Manual Travel Rule process where your counterparty VASP requests you to verify the PII information from your VASP's perspective. Once your VASP has a final result, you should call this API to notify your counterparty.

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

requestId

RequiredString

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]"

Min Length4

Max Length64

Pattern

[\w\d_=-]+

Example

testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5

[+]result

OptionalObject

Example

{
  "result": {
    "data": {
      "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": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5",
      "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

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

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

Status HTTP Status: 200, VerifyStatus: 100000

Success

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

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