POST / (Step 2 - PII Callback)

Version: 3.0.0

Url

https://{VASP_SERVICE_URL}/

GTR will callback you and inform you the PII, please verify the PII and return by the structure of RegularizeCallbackVerifyPIIResponse

Authentication

bearerAuth(http)

Scheme: bearer

Bearer Format: JWT

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Required)

Schema

	Property	Type	Required	Description
	beneficiaryVasp	String	No	Response status message associated with status code
	callbackData	Object	No	the child structure could be: BeforeOnChainAddressVerifyCallbackRequest, BeforeOnChainPIICallbackRequest,
Property Type Description address String Beneficiary's address. beneficiaryPublicKey String Beneficiary curve25519 public key, used to encrypt public keys when transmitting encrypted information to business systems beneficiaryVasp String Beneficiary VASP CODE allocated by GTR system beneficiaryVaspName String Beneficiary VASP name emptyPiiSchema String Originator info schema encryptedPayload String encrypted originator info, signed by beneficiary public key fiatName String fiatPrice String hashSalt String initiatorExpectVerifyFields Array<String> initiatorPublicKey String Initiator curve25519 public key, used to encrypt public keys when transmitting encrypted information to business systems initiatorVasp String Initiator VASP Code lawThresholdEnabled Boolean network String network name originatorPublicKey String Beneficiary curve25519 public key, used to encrypt public keys when transmitting encrypted information to business systems originatorVasp String Originator VASP CODE allocated by GTR system originatorVaspName String Originator VASP name piiSpecVersion String receiverPublicKey String Receiver curve25519 public key, used to encrypt public keys when transmitting encrypted information to business systems receiverVasp String Receiver VASP Code / Your VASP Code requestId String Unique request ID, recommended UUID. secretType Integer fixed 1 tag String Tag/Memo of the transaction. ticker String Token Name. travelruleId String txId String transaction id verificationDirection Integer See VerificationDirectionEnum
	callbackType	Integer	No	See VerifyStatusEnum
	invokeVaspCode	String	No	Before on chain initiator (Originator VASP)
	originatorVasp	String	No	Response status message associated with status code
	requestId	String	No	Unique request ID, recommended UUID.

Example

{
  "beneficiaryVasp": "string",
  "requestId": "string",
  "invokeVaspCode": "Originator VASP Code 1",
  "callbackData": {
    "piiSpecVersion": "string",
    "beneficiaryVasp": "Beneficiary VASP Code 1",
    "initiatorExpectVerifyFields": [
      [
        "LICENSE_NUMBER_US_CA",
        "NAME",
        "LOCAL_NAME",
        "PLACE_OF_BIRTH",
        "DATE_OF_BIRTH"
      ]
    ],
    "travelruleId": "string",
    "emptyPiiSchema": "{\"ivms101\":{\"OriginatingVASP\":...}}",
    "txId": "string",
    "originatorVasp": "Originator VASP Code 1",
    "receiverPublicKey": "Receiver VASP Public Key / Your Public Key",
    "network": "ETH,BTC...",
    "hashSalt": "string",
    "fiatName": "EUR,USD,USDT,FDUSD...",
    "requestId": "string",
    "beneficiaryVaspName": "Beneficiary VASP Name 1",
    "fiatPrice": "339.5",
    "tag": "memo:[account_id in service]",
    "beneficiaryPublicKey": "Beneficiary VASP 1 Public Key",
    "verificationDirection": "1 // 1: RECEIVER TO SENDER (YOU AS ORIGINATOR) CHECK, 2: SENDER TO RECEIVER (YOU AS BENEFICIARY) CHECK",
    "initiatorVasp": "Initiator VASP Code",
    "encryptedPayload": "[Curve 25519 Encrypted Payload] The encrypted PII info sent from originating VASP, the payload schema JSON should follow IVMS-101. And the payload is encrypted by Curve 25519 algorithm, which need your private key and originating vasp's public key to decrypt.",
    "ticker": "USDT,FDUSD...",
    "address": "Beneficiary Wallet Address / Account Address, mostly using hash id text, not a block id number",
    "lawThresholdEnabled": true,
    "receiverVasp": "Receiver VASP Code / Your VASP COde",
    "originatorPublicKey": "Originator VASP 1 Public Key",
    "secretType": 1,
    "originatorVaspName": "Originator VASP Name 1",
    "initiatorPublicKey": "Initiator VASP Public Key"
  },
  "originatorVasp": "string",
  "callbackType": 4
}

Responses

Status 200

Return the verify status, and please add beneficiaryVasp (you) into the decrypted ivms101, and encrypt by originator public key with cureve25519 and return back to GTR. (for other verify status, for example: verifyStatus code: 100001 (verification failed, please add the non-privacy reason to verifyMessage)

JSON Content

Schema

	Property	Type	Description
	data	Object
Property Type Description beneficiaryPublicKey String beneficiary public key emptyPiiSchema String empty schema encryptedPayload String beneficiary will put the beneficiaryVasp into ivms101 and use originator public key to encrypt and send back to originator vasp hashSalt String initiatorPublicKey String initiator curve25519 public key, used to encrypt public keys when transmitting encrypted information to business systems originatorPublicKey String originator public key receiverPublicKey String beneficiary public key requestId String Unique request ID, recommended UUID. secretType Integer fixed 1 verifyFields Array<Object> Property Type Description [*].message String [*].status Number See VerifyFieldStatusEnum [*].type String
	verifyMessage	String
	verifyStatus	Integer

Example

{
  "data": {
    "hashSalt": "string",
    "encryptedPayload": "[Curve25519 encrypted payload], The encrypted PII info sent from beneficiary VASP, they may brings the beneficiaryVasp to ivms101",
    "verifyFields": [
      {
        "type": "NAME",
        "message": "ok",
        "status": 1
      }
    ],
    "requestId": "string",
    "secretType": 1,
    "emptyPiiSchema": "{\"ivms101\":{\"OriginatingVASP\":...}}",
    "originatorPublicKey": "[Originator curve25519  public key]",
    "initiatorPublicKey": "[initiator curve25519  public key]",
    "beneficiaryPublicKey": "[Your curve25519 public key]",
    "receiverPublicKey": "[Your curve25519 public key]"
  },
  "verifyStatus": 0,
  "verifyMessage": "string"
}