sendTravelRuleMessage

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Travel Rule

USDC Access

Quotes

Trade Configurations

Sessions

Send PII for transaction

POSThttps://api.circle.com/v1/w3s/compliance/travelRule/sendPii

Sends Travel Rule message / PII for a transaction.

Body parameters

pii

object

Required

IVMS101 object of the Travel Rule message.

Show 6 properties

beneficiary

object

The natural or legal person or legal arrangement who is identified by the originator as the receiver of the requested VA transfer.

Show 2 properties

accountNumber

array of strings

beneficiaryPerson

array of objects

Required

Show 2 properties

legalPerson

object

Show 5 properties

countryOfRegistration

string

customerIdentification

string

geographicAddress

array of objects

Show 16 properties

name

object

Show 3 properties

nationalIdentification

object

Show 4 properties

naturalPerson

object

Show 6 properties

countryOfResidence

string

customerIdentification

string

dateAndPlaceOfBirth

object

Show 2 properties

geographicAddress

array of objects

Show 16 properties

name

object

Required

Show 3 properties

localNameIdentifier

array of objects

Show 3 properties

nameIdentifier

array of objects

Required

Show 3 properties

phoneticNameIdentifier

array of objects

Show 3 properties

nationalIdentification

object

Show 4 properties

beneficiaryVASP

object

Show 1 properties

beneficiaryVASP

object

Show 2 properties

legalPerson

object

Show 5 properties

countryOfRegistration

string

customerIdentification

string

geographicAddress

array of objects

Show 16 properties

name

object

Show 3 properties

nationalIdentification

object

Show 4 properties

naturalPerson

object

Show 6 properties

countryOfResidence

string

customerIdentification

string

dateAndPlaceOfBirth

object

Show 2 properties

geographicAddress

array of objects

Show 16 properties

name

object

Required

Show 3 properties

localNameIdentifier

array of objects

Show 3 properties

nameIdentifier

array of objects

Required

Show 3 properties

phoneticNameIdentifier

array of objects

Show 3 properties

nationalIdentification

object

Show 4 properties

originatingVASP

object

Show 1 properties

originatingVASP

object

Show 2 properties

legalPerson

object

Show 5 properties

countryOfRegistration

string

customerIdentification

string

geographicAddress

array of objects

Show 16 properties

name

object

Show 3 properties

nationalIdentification

object

Show 4 properties

naturalPerson

object

Show 6 properties

countryOfResidence

string

customerIdentification

string

dateAndPlaceOfBirth

object

Show 2 properties

geographicAddress

array of objects

Show 16 properties

name

object

Required

Show 3 properties

localNameIdentifier

array of objects

Show 3 properties

nameIdentifier

array of objects

Required

Show 3 properties

phoneticNameIdentifier

array of objects

Show 3 properties

nationalIdentification

object

Show 4 properties

originator

object

Show 2 properties

accountNumber

array of strings

originatorPersons

array of objects

Show 2 properties

legalPerson

object

Show 5 properties

countryOfRegistration

string

customerIdentification

string

geographicAddress

array of objects

Show 16 properties

name

object

Show 3 properties

nationalIdentification

object

Show 4 properties

naturalPerson

object

Show 6 properties

countryOfResidence

string

customerIdentification

string

dateAndPlaceOfBirth

object

Show 2 properties

geographicAddress

array of objects

Show 16 properties

name

object

Required

Show 3 properties

localNameIdentifier

array of objects

Show 3 properties

nameIdentifier

array of objects

Required

Show 3 properties

phoneticNameIdentifier

array of objects

Show 3 properties

nationalIdentification

object

Show 4 properties

payloadMetadata

object

Show 1 properties

transferPath

object

Show 1 properties

transferPath

array of objects

Show 2 properties

intermediaryVASP

object

Required

Show 2 properties

legalPerson

object

Show 5 properties

countryOfRegistration

string

customerIdentification

string

geographicAddress

array of objects

Show 16 properties

name

object

Show 3 properties

nationalIdentification

object

Show 4 properties

naturalPerson

object

Show 6 properties

countryOfResidence

string

customerIdentification

string

dateAndPlaceOfBirth

object

Show 2 properties

geographicAddress

array of objects

Show 16 properties

name

object

Required

Show 3 properties

localNameIdentifier

array of objects

Show 3 properties

nameIdentifier

array of objects

Required

Show 3 properties

phoneticNameIdentifier

array of objects

Show 3 properties

nationalIdentification

object

Show 4 properties

sequence

integer

Required

originatorVaspId

string

Required

idempotencyKey

string

Required

beneficiaryVaspId

string

Required

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.

txHash

string

Response

201

Response Body

object

beneficiaryAddressType

string

Possible address types.

beneficiaryVASPId

string

beneficiaryVaspName

string

firedRule

object

Show 2 properties

reason

string

Possible reasons for a Travel Rule decision recommendation.

requiredTravelRuleData

array of strings

ruleMatches

array of objects

Show 2 properties

status

object

Show 6 properties

travelRuleId

string

Unique identifier of the Travel Rule message.

travelRuleStatus

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 beneficiaryVASP has claimed the beneficiaryAddress
ACCEPTED - The beneficiaryVASP has run its due diligence and accepted the Travel Rule message. This is a terminal state
DENIED - The beneficiaryVASP 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.
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 beneficiaryVASP when it requests the originatorVASP to share PII for a transaction
SAVED - The transfer is BELOW_THRESHOLD, NON_CUSTODIAL or an internal transfer. Therefore, after being created, it is not transmitted, just saved.
REJECTED - The beneficiaryVASP does not control the destination address. This is a terminal state.

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.

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices