POST /api/verify/v2/verify_pii

Version: 3.0.0

Url

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

verify pii

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

	Property	Type	Required	Description
	amount	String	Yes
	emptyPiiSchema	String	No
	encryptedPayload	String	Yes
	expectVerifyFields	Array<String>	No
	fiatName	String	Yes
	fiatPrice	String	Yes
	initiatorPublicKey	String	No
	lawThresholdEnabled	Boolean	No
	piiSpecVersion	String	No
	requestId	String	Yes
	secretType	Integer	Yes
	targetVaspCode	String	Yes
	targetVaspPublicKey	String	No
	txId	String	No

Example

{
  "piiSpecVersion": "string",
  "amount": "string",
  "encryptedPayload": "string",
  "lawThresholdEnabled": true,
  "emptyPiiSchema": "string",
  "txId": "string",
  "targetVaspCode": "string",
  "fiatName": "string",
  "requestId": "string",
  "secretType": 0,
  "fiatPrice": "string",
  "initiatorPublicKey": "string",
  "expectVerifyFields": [
    "string"
  ],
  "targetVaspPublicKey": "string"
}

Responses

Status 200

OK

JSON Content

Schema

	Property	Type	Description
	data	Object
Property Type Description beneficiaryPublicKey String emptyPiiSchema String encryptedPayload String hashSalt String initiatorPublicKey String originatorPublicKey String receiverPublicKey String requestId String secretType Integer travelruleId String verifyFields Array<Object> Property Type Description [*].message String [*].status Integer [*].type String
	success	Boolean
	verifyMessage	String
	verifyStatus	Integer

Example

{
  "data": {
    "hashSalt": "string",
    "encryptedPayload": "string",
    "verifyFields": [
      {
        "message": "string",
        "type": "string",
        "status": 0
      }
    ],
    "requestId": "string",
    "secretType": 0,
    "travelruleId": "string",
    "emptyPiiSchema": "string",
    "initiatorPublicKey": "string",
    "originatorPublicKey": "string",
    "beneficiaryPublicKey": "string",
    "receiverPublicKey": "string"
  },
  "verifyStatus": 0,
  "success": true,
  "verifyMessage": "string"
}