Skip to main content

CryptoAmlTransactionDetailsDto

typestringrequired

Result type. Always TRANSACTION for a transaction check.

Possible values: [WALLET, TRANSACTION]

Default value: TRANSACTION
idstringrequired

Identifier of the check (amlId). Use it to request the result again or to generate PDF reports.

clientKeystringrequired

Key of the client that owns the check.

blockchainstringrequired

Blockchain network of the transaction.

Possible values: [BTC, LTC, BSV, ETH, TRON, POLYGON, BNB, ARBITRUM, BASE, AVALANCHE, MOONBEAM, DOT, SOLANA, TON, CARDANO, WORLDCOIN]

hashstringrequired

The checked transaction hash.

scorenumberrequired

Risk score of the transaction, as returned by the AML provider.

statestringrequired

State of the check. The result is ready when the state is FINISHED.

Possible values: [INITIAL, PROCESSING, FAILED, FINISHED]

errReasonstring

Reason of the failure. Present only when state is FAILED.

amountstring

Transferred amount, returned as a string to preserve precision.

blockNumbernumberrequired

Number of the block that includes the transaction.

timestampnumberrequired

Timestamp of the transaction.

amountPricenumber

Price of the transferred amount.

totalInputsnumber

Total number of inputs of the transaction.

totalOutputsnumber

Total number of outputs of the transaction.

uof object[]required

Uses of funds: where the funds of the transaction were sent. Items have forward: true.

  • Array [
  • hashstring

    Hash of the transaction through which the funds moved.

    forwardbooleanrequired

    true for items of uof (funds sent onward from the checked wallet or transaction), false for items of sof (funds received from the source).

    ownerstringrequired

    Name of the owner of the counterparty address, if identified (for example an exchange or a service).

    scorenumber

    Risk score of this source of funds or use of funds, as returned by the AML provider.

    typestringrequired

    Category of the source or destination, for example the type of the entity that owns the counterparty address.

    depth objectrequired

    Number of hops between the checked wallet or transaction and this counterparty. Either a single number or a { minimum, maximum } range.

    oneOf
    number
    exposureTypestring

    direct if the counterparty is one hop away, indirect if it is further, unclassified if the depth is unknown or is a range spanning both.

    Possible values: [direct, indirect, unclassified]

    amountnumberrequired

    Amount of funds attributed to this counterparty.

    addressstringrequired

    Counterparty address.

    sharenumberrequired

    Share of the total funds attributed to this counterparty (percentage).

    transactionCountnumber

    Number of transactions with this counterparty (if applicable).

    unidentifiedboolean

    true if the counterparty could not be identified (if applicable).

    unknownboolean

    true if the counterparty is unknown to the AML provider (if applicable).

    amountCurnumber

    Amount expressed in the corresponding currency, as returned by the AML provider (if applicable).

    clusternumber

    Identifier of the address cluster the counterparty belongs to (if applicable).

    directStampnumber

    Provider timestamp of the direct transaction with the counterparty (if applicable).

    timestampnumber

    Timestamp of the funds movement (if applicable).

    listTypestring

    Category of the list the counterparty was matched against (if applicable).

    amountDecnumber

    Decimal representation of the amount (if applicable).

    directTxstring

    Hash of the direct transaction with the counterparty (if applicable).

    symbolstring

    Symbol of the asset the amount is expressed in (if applicable).

  • ]
  • sof object[]required

    Sources of funds: where the funds of the transaction came from. Items have forward: false.

  • Array [
  • hashstring

    Hash of the transaction through which the funds moved.

    forwardbooleanrequired

    true for items of uof (funds sent onward from the checked wallet or transaction), false for items of sof (funds received from the source).

    ownerstringrequired

    Name of the owner of the counterparty address, if identified (for example an exchange or a service).

    scorenumber

    Risk score of this source of funds or use of funds, as returned by the AML provider.

    typestringrequired

    Category of the source or destination, for example the type of the entity that owns the counterparty address.

    depth objectrequired

    Number of hops between the checked wallet or transaction and this counterparty. Either a single number or a { minimum, maximum } range.

    oneOf
    number
    exposureTypestring

    direct if the counterparty is one hop away, indirect if it is further, unclassified if the depth is unknown or is a range spanning both.

    Possible values: [direct, indirect, unclassified]

    amountnumberrequired

    Amount of funds attributed to this counterparty.

    addressstringrequired

    Counterparty address.

    sharenumberrequired

    Share of the total funds attributed to this counterparty (percentage).

    transactionCountnumber

    Number of transactions with this counterparty (if applicable).

    unidentifiedboolean

    true if the counterparty could not be identified (if applicable).

    unknownboolean

    true if the counterparty is unknown to the AML provider (if applicable).

    amountCurnumber

    Amount expressed in the corresponding currency, as returned by the AML provider (if applicable).

    clusternumber

    Identifier of the address cluster the counterparty belongs to (if applicable).

    directStampnumber

    Provider timestamp of the direct transaction with the counterparty (if applicable).

    timestampnumber

    Timestamp of the funds movement (if applicable).

    listTypestring

    Category of the list the counterparty was matched against (if applicable).

    amountDecnumber

    Decimal representation of the amount (if applicable).

    directTxstring

    Hash of the direct transaction with the counterparty (if applicable).

    symbolstring

    Symbol of the asset the amount is expressed in (if applicable).

  • ]
  • assets object[]required

    Assets transferred by the transaction.

  • Array [
  • supportedbooleanrequired

    Whether the asset is supported by the AML provider.

    namestringrequired

    Name of the asset.

    symbolstringrequired

    Symbol of the asset.

    iconstringrequired

    Icon URL or identifier of the asset.

  • ]
  • entities object[]required

    Entities related to the transaction, for example exchanges or mixers.

  • Array [
  • idstringrequired

    Identifier of the entity.

    scorenumberrequired

    Risk score of the entity.

    scoreTypestringrequired

    Name of the risk type the score belongs to.

    namestringrequired

    Name of the entity, for example an exchange or a service.

    scoreTypeIdstringrequired

    Identifier of the risk type the score belongs to.

  • ]
  • raw objectrequired

    Raw transaction data returned by the AML provider.

    property name*any

    Raw transaction data returned by the AML provider.

    isReportReceivedboolean

    Whether the AML provider returned a report for this check.

    createdAtstring<date-time>required

    Time the check was created.

    pdfReports object[]

    PDF reports generated for this check. Returned only by GET /api/public/crypto-aml/{amlId}/details, not in the webhook.

  • Array [
  • requestIdstringrequired

    Identifier of the report request. It is generated by the client when the report is requested.

    amlIdstringrequired

    Identifier of the check the report belongs to.

    typestringrequired

    Type of the check: WALLET or TRANSACTION.

    Possible values: [WALLET, TRANSACTION]

    statusstringrequired

    Status of the report generation: PENDING, then GENERATED or FAILED.

    Possible values: [PENDING, GENERATED, FAILED]

    pathstring

    Path of the generated file. Present only when status is GENERATED. Download it with GET /api/public/file/{path}.

    error object

    Error details. Present only when status is FAILED.

    codestringrequired

    Error code.

    messagestringrequired

    Human readable error message.

    sourceUpdatedAtstring<date-time>

    AML snapshot used to generate this PDF

    createdAtstring<date-time>required
    updatedAtstring<date-time>required

    Time the report status was last updated.

  • ]
  • updatedAtstring<date-time>required

    Time the check was last updated.

    CryptoAmlTransactionDetailsDto
    {
    "type": "TRANSACTION",
    "id": "string",
    "clientKey": "string",
    "blockchain": "BTC",
    "hash": "string",
    "score": 0,
    "state": "INITIAL",
    "errReason": "string",
    "amount": "string",
    "blockNumber": 0,
    "timestamp": 0,
    "amountPrice": 0,
    "totalInputs": 0,
    "totalOutputs": 0,
    "uof": [
    {
    "hash": "string",
    "forward": true,
    "owner": "string",
    "score": 0,
    "type": "string",
    "depth": 0,
    "exposureType": "direct",
    "amount": 0,
    "address": "string",
    "share": 0,
    "transactionCount": 0,
    "unidentified": true,
    "unknown": true,
    "amountCur": 0,
    "cluster": 0,
    "directStamp": 0,
    "timestamp": 0,
    "listType": "string",
    "amountDec": 0,
    "directTx": "string",
    "symbol": "string"
    }
    ],
    "sof": [
    {
    "hash": "string",
    "forward": true,
    "owner": "string",
    "score": 0,
    "type": "string",
    "depth": 0,
    "exposureType": "direct",
    "amount": 0,
    "address": "string",
    "share": 0,
    "transactionCount": 0,
    "unidentified": true,
    "unknown": true,
    "amountCur": 0,
    "cluster": 0,
    "directStamp": 0,
    "timestamp": 0,
    "listType": "string",
    "amountDec": 0,
    "directTx": "string",
    "symbol": "string"
    }
    ],
    "assets": [
    {
    "supported": true,
    "name": "string",
    "symbol": "string",
    "icon": "string"
    }
    ],
    "entities": [
    {
    "id": "string",
    "score": 0,
    "scoreType": "string",
    "name": "string",
    "scoreTypeId": "string"
    }
    ],
    "raw": {},
    "isReportReceived": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "pdfReports": [
    {
    "requestId": "string",
    "amlId": "string",
    "type": "WALLET",
    "status": "PENDING",
    "path": "string",
    "error": {
    "code": "string",
    "message": "string"
    },
    "sourceUpdatedAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }