v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transactions

Fully Validate transfer

Fully Validate your transfer with this method

post/tx/validate/full

Request body

transactionAssetstring required

Asset symbol (BTC,ETH)

transactionAmountstring required

Amount in base unit of the asset (satoshi, wei, etc)

transactionAssetDecimalsnumber

Asset decimals

originatorDidstring

Decentralized Identifier

beneficiaryDidstring

Decentralized Identifier

originatorVASPdidstring

Decentralized Identifier

beneficiaryVASPdidstring

Decentralized Identifier

beneficiaryVASPnamestring

Beneficiary VASP Name

encryptedstring

Encrypted Personal Identificable Information (obscure schema-less value)

protocol'TRLight' | 'TRP' | 'OpenVASP'
notificationEmailstring

Beneficiary VASP Notification Email

skipBeneficiaryDataValidationboolean

Disable beneficiary data validation (opportunistic compliance)

travelRuleBehaviorboolean

Should consider beneficiary's jurisdiction in determining if a transfer is of type TRAVEL_RULE

networkstring

Chainalysis network

validatePartyFields'BENEFICIARY' | 'ORIGINATOR' | 'ALL'

Validate transfers based on party

onBehalfOfMyselfboolean

Autopopulate originator and beneficiary fields with institution's information

Response

Full transfer validation response

isValidboolean required

Is transfer valid?

type'BELOW_THRESHOLD' | 'NON_CUSTODIAL' | 'TRAVELRULE' | 'UNKNOWN' required

Type of the Transfer

  • BELOW_THRESHOLD Transfer is below all threshold.
  • NON_CUSTODIAL Transfer is on a customer owned wallet. Proof required.
  • TRAVELRULE Transfer is between VASPs. TravelRule transfer created.
  • UNKNOWN Transfer with any missing information.
beneficiaryAddressType'UNKNOWN' | 'HOSTED' | 'UNHOSTED'

Type of the Blockchain Address

  • UNKNOWN Address is not kwown.
  • HOSTED Address is hosted by a custodial service.
  • UNHOSTED Address is unhosted
addressSource'UNKNOWN' | 'ADDRESS_HASH' | 'ADDRESS_GRAPH' | 'CHAINALYSIS' | 'ELLIPTIC'

Source of address information

  • UNKNOWN Address is not kwown.
  • ADDRESS_HASH Notabene private address network.
  • ADDRESS_GRAPH Notabene address graph.
  • CHAINALYSIS Chainalysis
  • ELLIPTIC Elliptic
  • CRYSTAL Crystal
beneficiaryVASPnamestring

Name of the beneficiary VASP

errorsstring[]
warningsstring[]