API Reference

Eligibility for receiving PII

posthttps://api.circle.com/v1/w3s/compliance/travelRule/validityCheck

  • Reference
  • Playground

Checks Travel Rule eligibility for receiving a given transaction.

Body parameters
customerJurisdiction
string
Required

The jurisdiction your VASP is operating in.

transactionId
string

Unique identifier of the Circle Wallets transaction.

transactionInfo
object

The attributes required to identify a particular blockchain transaction.

amount
string
Required

The amount of the transaction.

asset
string
Required

Blockchains supported by Circle Travel Rule.

Allowed valuesAVAXETHMATICSOLUSDCETH-SEPOLIA
destination
string
Required

The destination address of the transaction.

origin
string
Required

The source address of the transaction.

txHash
string
Required

The transaction hash of the transaction.

travelRuleId
string

Unique identifier of the Travel Rule message.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "beneficiaryVaspId": "",
3  "errors": [
4    ""
5  ],
6  "firedRule": {
7    "name": "",
8    "precedence": 0
9  },
10  "matchedRules": [
11    {
12      "name": "",
13      "precedence": 0
14    }
15  ],
16  "originatorAddressType": "HOSTED",
17  "originatorVaspId": "",
18  "originatorVaspName": "",
19  "reason": "UNKNOWN_WALLET",
20  "recommendation": "PROCEED_WITH_TRANSACTION",
21  "requiredTravelRuleData": [
22    ""
23  ],
24  "status": {
25    "code": 0,
26    "errors": [
27      ""
28    ],
29    "externalMessage": "",
30    "message": "",
31    "property": "",
32    "version": ""
33  }
34}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.