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
Update Travel Rule message
PUThttps://api.circle.com/v1/w3s/compliance/travelRule/{travelRuleId}
Updates a Travel Rule message.
Path parameters
travelRuleId
uuid
Required
Body parameters
idempotencyKey
string
reason
string
status
string
Indicates the status of the Travel Rule message
- NEW - New Travel Rule message is created but is not sent to the
beneficiaryVASP - SENT - New Travel Rule message is successfully sent to the
beneficiaryVASP - CLAIMED - The
beneficiaryVASPhas claimed thebeneficiaryAddress - ACCEPTED - The
beneficiaryVASPhas run its due diligence and accepted the Travel Rule message. This is a terminal state - DENIED - The
beneficiaryVASPhas denied this Travel Rule message, due to some failure while running checks (could be incomplete PII or screening error). This is a terminal state. - CANCELLED - The Travel Rule transfer was cancelled at any state by the
originatorVASP. This is a terminal state. - INCOMPLETE - A status when a placeholder PII message is created by the
beneficiaryVASPwhen it requests theoriginatorVASPto share PII for a transaction - SAVED - The transfer is
BELOW_THRESHOLD,NON_CUSTODIALor an internal transfer. Therefore, after being created, it is not transmitted, just saved. - REJECTED - The
beneficiaryVASPdoes not control the destination address. This is a terminal state.
txHash
string
The transaction hash of the transaction.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "beneficiaryAddressType": "HOSTED",
3 "beneficiaryVASPId": "",
4 "beneficiaryVaspName": "",
5 "firedRule": {
6 "name": "",
7 "precedence": 0
8 },
9 "reason": "UNKNOWN_WALLET",
10 "requiredTravelRuleData": [
11 ""
12 ],
13 "ruleMatches": [
14 {
15 "name": "",
16 "precedence": 0
17 }
18 ],
19 "status": {
20 "code": 0,
21 "errors": [
22 ""
23 ],
24 "externalMessage": "",
25 "message": "",
26 "property": "",
27 "version": ""
28 },
29 "travelRuleId": "36790743-b78d-4061-9558-1af9a9c837bd",
30 "travelRuleStatus": "SENT"
31}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
