Transaction Screening Objects

ComplianceResult

ParameterTypeDescription
amlAmlScreeningResultAn object containing AML screening result information.
amlListarray of AmlScreeningResultList of AML screening result objects.
amlRegistrationAmlRegistrationAn object containing AML registration information.
trTravelRuleScreeningResultAn object containing Travel Rule screening result information.
statusstringThe status of the AML or Travel Rule screening request.

AmlScreeningResult

ParameterTypeDescription
providerstring[optional] The AML service provider.
payloadanyThe response of the AML service provider.
screeningStatusstringThe status of the AML screening request.
bypassReasonstringThe reason the transaction bypassed AML screening.
timestampnumberThe date of the AML screening request in timestamp format.
categorystring[optional, Chainalysis only] The risk category included the transaction screening.
categoryIdnumber[optional, Chainalysis only] The Chainalysis ID of the risk category.
customerRefIdstring[optional] The Customer Reference ID associated with the transaction.
destAddressstring[optional] For multi-destination transactions, the destination address with the highest risk that's being screened.
externalIdstring[optional] The AML provider's ID of the screening result.
matchedAlertany[optional, Chainalysis only] The alert corresponding to the result for matchedRule.
matchedRuleany[optional] The AML Post-Screening Policy rule that matched with the transaction.
matchedPrescreeningRuleany[optional] The AML Transaction Screening Policy rule that matched with the transaction.
risk[optional] The risk score for your transaction.

- Chainalysis v1 values: [highRisk, lowRisk, unknown]
- Chainalysis v2 values: [severeRisk, highRisk, mediumRisk, lowRisk, noRiskDetected]
- Elliptic v1 and Holistic values: [0.0-10.0, noRiskDetected]
verdictstring[optional] [ACCEPT, REJECT, ALERT]

AmlRegistration

ParameterTypeDescription
providerstringThe AML service provider.
successbooleanSpecifies whether the AML registration was successful.
timestampnumberThe date of the AML registration in timestamp format.

TravelRuleScreeningResult

ParameterTypeDescription
providerstringThe Travel Rule service provider.
verdictstring[ACCEPT, REJECT, ALERT, WAIT, FREEZE, CANCEL]
payloadanyThe response of the Travel Rule service provider.
matchedRuleanyThe Travel Rule Post-Screening Policy rule that matched with the transaction.
matchedPrescreeningRuleanyThe Travel Rule Transaction Screening Policy rule that matched with the transaction.
bypassReasonstringThe reason the transaction bypassed Travel Rule screening.
timestampnumberThe date of the Travel Rule screening request in timestamp format.
statusstringThe status of the Travel Rule screening request.