Skip to main content

CryptoAmlAddressDetailsDto

typestringrequired

Result type. Always WALLET for a wallet check.

Possible values: [WALLET, TRANSACTION]

Default value: WALLET
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.

applicantIdstring

Applicant the wallet is assigned to, if any.

blockchainstringrequired

Blockchain network of the wallet.

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

reviewStatusstringrequired

Manual review decision for the wallet: UNKNOWN until a reviewer decides in Workplace, then APPROVED or REJECTED.

Possible values: [UNKNOWN, APPROVED, REJECTED]

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.

addressstringrequired

The checked wallet address.

scorenumberrequired

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

amountstring

Balance of the wallet at the time of the check, returned as a string to preserve precision.

uof object[]required

Uses of funds: where the funds of the wallet 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 wallet 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).

  • ]
  • addressInfo objectrequired

    Information about the address. The set of fields depends on the blockchain type: account-based, UTXO-based or EVM.

    oneOf
    addressstringrequired

    The checked address.

    ownerstringrequired

    Owner of the address, if identified.

    descriptionstringrequired

    Description of the address.

    type objectrequired

    Type of the address.

    idstring

    Identifier of the address type.

    namestringrequired

    Name of the address type, for example the kind of service that owns the address.

    scorenumberrequired

    Risk score associated with the address type.

    txCountnumberrequired

    Total number of transactions.

    txReceivedCountnumberrequired

    Number of received transactions.

    txSentCountnumberrequired

    Number of sent transactions.

    tagsstring[]required

    Tags associated with the address.

    balance objectrequired

    Balance of the address.

    amountstringrequired

    Balance amount, returned as a string to preserve precision.

    pricenumber

    Price of the asset at the time of the check.

    priceTimestampnumber

    Timestamp when the price was recorded.

    symbolstring

    Symbol of the asset.

    firstSeennumberrequired

    Timestamp when the address was first seen.

    lastSeennumberrequired

    Timestamp when the address was last seen.

    parentCountnumberrequired

    Number of parent addresses.

    parentNativeCountnumberrequired

    Number of native parent addresses.

    addressTypestringrequired

    Kind of the address: address for a regular account or contract for a smart contract.

    conflictbooleanrequired

    Flag returned by the AML provider indicating conflicting data for this address.

    totalETHTxsnumberrequired

    Total number of native-coin transactions.

    totalInternalTxsnumberrequired

    Total number of internal transactions.

    totalTokensTxsnumberrequired

    Total number of token transactions.

    assets object[]required

    Assets held by the address.

  • 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 wallet, 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.

  • ]
  • sharesByType objectrequired

    Share of funds by risk type, keyed by type name.

    property name*number
    riskByType objectnullable

    Risk score by risk type, keyed by type name.

    property name*number
    isMonitoringbooleanrequired

    Whether the wallet is under continuous AML monitoring.

    lastUpdateDatestring<date-time>required

    Time the result was last updated.

    outdatedbooleanrequired

    true when a monitoring update changed the score after the last full check, so the stored details may be stale.

    isReportReceivedboolean

    Whether the AML provider returned a report for this check.

    createdAtstring<date-time>required

    Time the check was created.

    timelines object[]nullablerequired

    History of events of the check. null if there are none.

  • Array [
  • idstringrequired

    Identifier of the event.

    requestUniqueIdstringrequired

    Identifier of the request that caused the event.

    eventNamestringrequired

    Type of the event.

    Possible values: [CRYPTO_AML_STATUS_UPDATED, CRYPTO_AML_EXPORTED_DATA, CRYPTO_CREATED_AML_COMMENT, CRYPTO_AML_MONITORING_DISABLED, CRYPTO_AML_MONITORING_ENABLED, CRYPTO_AML_START_PROCESS, CRYPTO_RETRIEVED_AML_RESULT, CRYPTO_RETRIEVED_AML_RESULT_ERROR, CRYPTO_AML_ASSIGNED_TO_APPLICANT, CRYPTO_AML_REFRESH_PROCESS, CRYPTO_AML_SCORE_UPDATED, CRYPTO_AML_PDF_REPORT_REQUESTED, CRYPTO_AML_PDF_REPORT_GENERATED, CRYPTO_AML_PDF_REPORT_FAILED]

    applicantIdstring

    Applicant the event is related to, if any.

    appKeystring

    Key of the Application the event is related to, if any.

    data objectnullablerequired

    Additional event data. The content depends on the event type.

    property name*anynullable

    Additional event data. The content depends on the event type.

    amlIdstringrequired

    Identifier of the check the event belongs to.

    userIdnumberrequired

    Identifier of the user who caused the event.

    deviceobjectrequired

    Device details of the request that caused the event.

    geoobjectrequired

    Geolocation details of the request that caused the event.

    createdAtstring<date-time>required

    Time the event was created.

    updatedAtstring<date-time>required

    Time the event was last updated.

  • ]
  • comments object[]nullablerequired

    Comments left on the check by reviewers. null if there are none.

  • Array [
  • idstringrequired

    Identifier of the comment.

    contentstringrequired

    Text of the comment.

    amlIdstringrequired

    Identifier of the check the comment belongs to.

    authorIdnumberrequired

    Identifier of the user who wrote the comment.

    parentIdstring

    Identifier of the parent comment when this comment is a reply.

    authorNamestringrequired

    Full name of the user who wrote the comment.

    updatedAtstring<date-time>required

    Time the comment was last updated.

    createdAtstring<date-time>required

    Time the comment was created.

    parentCommentcircular(CryptoAmlCommentDto)
  • ]
  • 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.

    CryptoAmlAddressDetailsDto
    {
    "type": "WALLET",
    "id": "string",
    "clientKey": "string",
    "applicantId": "string",
    "blockchain": "BTC",
    "reviewStatus": "UNKNOWN",
    "state": "INITIAL",
    "errReason": "string",
    "address": "string",
    "score": 0,
    "amount": "string",
    "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"
    }
    ],
    "addressInfo": {
    "address": "string",
    "owner": "string",
    "description": "string",
    "type": {
    "id": "string",
    "name": "string",
    "score": 0
    },
    "txCount": 0,
    "txReceivedCount": 0,
    "txSentCount": 0,
    "tags": [
    "string"
    ],
    "balance": {
    "amount": "string",
    "price": 0,
    "priceTimestamp": 0,
    "symbol": "string"
    },
    "firstSeen": 0,
    "lastSeen": 0,
    "parentCount": 0,
    "parentNativeCount": 0,
    "addressType": "string",
    "conflict": true,
    "totalETHTxs": 0,
    "totalInternalTxs": 0,
    "totalTokensTxs": 0,
    "assets": [
    {
    "supported": true,
    "name": "string",
    "symbol": "string",
    "icon": "string"
    }
    ]
    },
    "entities": [
    {
    "id": "string",
    "score": 0,
    "scoreType": "string",
    "name": "string",
    "scoreTypeId": "string"
    }
    ],
    "sharesByType": {},
    "riskByType": {},
    "isMonitoring": true,
    "lastUpdateDate": "2024-07-29T15:51:28.071Z",
    "outdated": true,
    "isReportReceived": true,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "timelines": [
    {
    "id": "string",
    "requestUniqueId": "string",
    "eventName": "CRYPTO_AML_STATUS_UPDATED",
    "applicantId": "string",
    "appKey": "string",
    "data": {},
    "amlId": "string",
    "userId": 0,
    "device": {},
    "geo": {},
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "comments": [
    {
    "id": "string",
    "content": "string",
    "amlId": "string",
    "authorId": 0,
    "parentId": "string",
    "authorName": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "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"
    }