> ## Documentation Index
> Fetch the complete documentation index at: https://wallet-docs.iexexchanger.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get AML data for deposit by your order_id

> AML-скрин source-of-funds депозита по вашему order_id (label).



## OpenAPI

````yaml /openapi-public.json get /v1/public/deposits/by-order-id/{orderId}/aml
openapi: 3.0.0
info:
  title: Wallet Platform — Public API
  description: >-
    API для интеграции CMS обменника: создание депозитов и выплат, отслеживание
    статусов, справочники активов и сетей.


    ## Аутентификация

    Каждый запрос подписывается HMAC-SHA256. Обязательные заголовки:

    - `X-Api-Id` — публичный идентификатор ключа (выдаётся в админке).

    - `X-Api-Key` — публичный ключ.

    - `X-Timestamp` — Unix-секунды; сервер принимает ±300 сек от своего времени.

    - `X-Signature` — `HMAC_SHA256_Hex( X-Timestamp + "." + raw_body, api_secret
    )`. Для GET тело пустое.

    - `X-Idempotency-Key` — опционально (UUID). Гарантирует, что повторный POST
    не создаст дубликат.


    Дополнительно: IP-вызывающего должен быть в whitelist сайта (настраивается в
    админке). Секрет (`api_secret`) показывается один раз при создании ключа и
    хранится только у вас.


    ## Формат ответа

    Все ответы — единый envelope: `{ "ok": true, "data": ... }` при успехе либо
    `{ "ok": false, "error": { "code": "...", "message": "..." } }` при ошибке.


    ## Идемпотентность

    Создание депозита/выплаты идемпотентно по вашему `order_id` (уникален в
    рамках сайта и актива) и/или по `X-Idempotency-Key`. Повторный вызов с тем
    же ключом вернёт исходный объект, а не создаст новый.


    ## Webhooks (исходящие)

    При смене статуса платформа шлёт POST на ваш `callback_url`. Заголовки:
    `X-Event-Type`, `X-Event-Id` (uuid, идемпотентность на вашей стороне),
    `X-Timestamp`, `X-Signature` = `HMAC_SHA256_Hex(raw_body, callback_secret)`.
    Проверяйте подпись перед обработкой.

    События: `deposit.tx_detected`, `deposit.finalized`, `deposit.failed`,
    `deposit.refunded`, `payout.broadcasted`, `payout.confirmed`,
    `payout.failed`.

    Доставка считается успешной при HTTP 2xx за 10 секунд. Ретраи: 30s, 2m, 10m,
    1h, 6h, 24h (до 8 попыток).
  version: '1'
  contact: {}
servers: []
security:
  - X-Api-Id: []
    X-Api-Key: []
    hmac: []
    X-Timestamp: []
tags: []
paths:
  /v1/public/deposits/by-order-id/{orderId}/aml:
    get:
      tags:
        - public · deposits
      summary: Get AML data for deposit by your order_id
      description: AML-скрин source-of-funds депозита по вашему order_id (label).
      operationId: DepositPublicController_getAmlByOrderId
      parameters:
        - name: orderId
          required: true
          in: path
          description: Ваш order_id, переданный при создании.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicDepositAmlResponseDto'
      security:
        - hmac: []
components:
  schemas:
    PublicDepositAmlResponseDto:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          description: Публичный идентификатор депозита (тот же, что в GET /{uuid}).
        orderId:
          type: string
          example: order_42_abc
          description: Ваш order_id (label), переданный при создании.
        assetCode:
          type: string
          example: USDT_TRC20
        network:
          type: string
          example: TRON
          description: Код сети депозита.
        senderAddress:
          type: string
          nullable: true
          example: TSenderAddrXyz...
          description: >-
            Адрес отправителя входящей транзакции — именно он проходит
            AML-скрин. null пока tx не замечена.
        amlStatus:
          type: string
          enum:
            - not_checked
            - passed
            - flagged
            - hold
            - rejected
          example: passed
          description: >-
            Итоговый AML-статус депозита: not_checked (не проверялся / AML выкл)
            → passed (чисто) | flagged (подозрительно, но не блок) | hold
            (заблокирован, ждёт ручного решения) | rejected (отклонён).
        checkState:
          type: string
          enum:
            - pending
            - success
            - failed
            - error
            - skipped
          nullable: true
          example: success
          description: >-
            Состояние запроса к провайдеру: pending | success | failed | error |
            skipped (НЕ значит «чисто»).
        riskScore:
          type: string
          nullable: true
          example: '12.50'
          description: Risk-score 0–100 (string). null если проверки не было.
        riskLevel:
          type: string
          enum:
            - low
            - medium
            - high
            - severe
          nullable: true
          example: low
          description: >-
            Уровень риска. severe =
            sanctions/terrorism/stolen/child_exploitation (блок независимо от
            score).
        decision:
          type: string
          enum:
            - pass
            - flag
            - block
          nullable: true
          example: pass
          description: 'Решение скрининга: pass | flag | block.'
        provider:
          type: string
          nullable: true
          example: getblock
          description: Код AML-провайдера.
        topSignal:
          type: string
          nullable: true
          example: mixer
          description: >-
            Топ-сигнал риска (категория с максимальным весом): mixer | sanctions
            | scam | darknet | …
        signals:
          type: object
          additionalProperties:
            type: number
          nullable: true
          example:
            mixer: 0.8
            scam: 0.1
          description: >-
            Карта сигналов риска и их весов (0..1). null если провайдер их не
            вернул.
        reportUrl:
          type: string
          nullable: true
          description: Ссылка на полный отчёт провайдера (если есть).
        shareUrl:
          type: string
          nullable: true
          description: Публичная share-ссылка на отчёт (если есть).
        checkedAt:
          type: string
          format: date-time
          nullable: true
          description: Когда выполнен AML-скрин. null если проверки не было.
        manualAction:
          type: string
          enum:
            - release
            - quarantine_now
          nullable: true
          example: null
          description: >-
            Ручное действие оператора над заблокированным депозитом: release
            (разрешить свип) | quarantine_now.
        manualActionAt:
          type: string
          format: date-time
          nullable: true
          description: Когда применено ручное действие.
        manualActionReason:
          type: string
          nullable: true
          description: Причина ручного действия (комментарий оператора).
      required:
        - uuid
        - orderId
        - assetCode
        - network
        - senderAddress
        - amlStatus
        - checkState
        - riskScore
        - riskLevel
        - decision
        - provider
        - topSignal
        - signals
        - reportUrl
        - shareUrl
        - checkedAt
        - manualAction
        - manualActionAt
        - manualActionReason
  securitySchemes:
    X-Api-Id:
      type: apiKey
      in: header
      name: X-Api-Id
      description: Публичный идентификатор API-ключа
    X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Публичный API-ключ
    hmac:
      type: apiKey
      in: header
      name: X-Signature
      description: HMAC-SHA256-Hex(timestamp + "." + raw_body, api_secret)
    X-Timestamp:
      type: apiKey
      in: header
      name: X-Timestamp
      description: Unix-секунды, ±300с

````