We refreshed our doc site!
Bookmarked links may have changed
Read release notesWe refreshed our doc site!
Bookmarked links may have changed
Read release notesPOSThttps://api.circle.com/v1/w3s/compliance/travelRule/sendPii
Sends Travel Rule message / PII for a transaction.
IVMS101 object of the Travel Rule message.
The natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.
Blockchains supported by Circle Travel Rule.
The destination address of the transaction.
The source address of the transaction.
Possible address types.
Possible reasons for a Travel Rule decision recommendation.
Unique identifier of the Travel Rule message.
Indicates the status of the Travel Rule message
beneficiaryVASP
beneficiaryVASP
beneficiaryVASP
has claimed the beneficiaryAddress
beneficiaryVASP
has run its due diligence and accepted the Travel Rule message. This is a terminal statebeneficiaryVASP
has denied this Travel Rule message, due to some failure while running checks (could be incomplete PII or screening error). This is a terminal state.originatorVASP
. This is a terminal state.beneficiaryVASP
when it requests the originatorVASP
to share PII for a transactionBELOW_THRESHOLD
, NON_CUSTODIAL
or an internal transfer. Therefore, after being created, it is not transmitted, just saved.beneficiaryVASP
does not control the destination address. This is a terminal state.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}