We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Web3 Services
API Overview
Configurations
Configurations
Developer-Controlled Wallets
Smart Contract Platform
User-Controlled Wallets
Compliance Engine
USDC Access
Eligibility for sending PII
POSThttps://api.circle.com/v1/w3s/compliance/travelRule/eligibilityCheck
Checks eligibility for sending Travel Rule for a given transaction.
Body parameters
transactionAsset
string
Required
Blockchains supported by Circle Travel Rule.
transactionAmount
string
Required
destination
string
Required
The destination address of the transaction.
customerJurisdiction
string
Required
origin
string
The source address of the transaction.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "beneficiaryAddressType": "HOSTED",
3 "beneficiaryVaspId": "",
4 "beneficiaryVaspName": "",
5 "errors": [
6 ""
7 ],
8 "firedRule": {
9 "name": "",
10 "precedence": 0
11 },
12 "matchedRules": [
13 {
14 "name": "",
15 "precedence": 0
16 }
17 ],
18 "originatorVaspId": "",
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-2024 Circle Technology Services, LLC. All rights reserved.
