API Reference

Eligibility for sending PII

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

Reference
Playground

Checks eligibility for sending Travel Rule for a given transaction.

Body parameters

transactionAsset

string

Required

Blockchains supported by Circle Travel Rule.

Allowed valuesAVAXETHMATICSOLUSDCETH-SEPOLIA

transactionAmount

string

Required

The amount of the transaction.

destination

string

Required

The destination address of the transaction.

customerJurisdiction

string

Required

The jurisdiction your VASP is operating in.

origin

string

The source address of the transaction.

Response

200

Response Body

object

beneficiaryAddressType

string

Possible address types.

Allowed valuesUNKNOWNHOSTEDUNHOSTED

beneficiaryVaspId

string

beneficiaryVaspName

string

errors

array of strings

firedRule

object

Show 2 properties

name

string

precedence

integer

matchedRules

array of objects

Show 2 properties

name

string

precedence

integer

originatorVaspId

string

reason

string

Possible reasons for a Travel Rule decision recommendation.

Allowed valuesBELOW_THRESHOLDTRAVEL_RULEUNKNOWN_WALLETNON_CUSTODIAL_WALLETPROVEN_WALLETFAILED_RULES_EVALUATIONTRAVEL_RULE_MESSAGE_NOT_RECEIVEDINVALID_PII

recommendation

string

Possible Travel Rule decision recommendations.

Allowed valuesPROCEED_WITH_TRANSACTIONPREVENT_TRANSACTIONFREEZE_WALLET

requiredTravelRuleData

array of strings

status

object

Show 6 properties

code

integer

errors

array of strings

externalMessage

string

message

string

property

string

version

string

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?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy