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

# Screen a crypto address

> Scope kyt:check. A new check reserves the current quoted USDT price. Returns HTTP 200, initially status=processing; poll kyt_check_get. Reusing ext_id returns the existing tenant check without another charge. Keep the same network/address for that ext_id. A completed cached result may be returned at price_usdt=0; refresh=true bypasses the address cache, but not ext_id replay. KYT does not itself approve or reject deposits or withdrawals.



## OpenAPI

````yaml /openapi/partner.openapi.yaml post /api/partner/kyt_check
openapi: 3.1.0
info:
  title: IMBA Partner API
  version: 1.1.0
  summary: B2B Partner API for USDT settlement, cards, eSIM, gift cards, and KYT
  description: |
    B2B Partner API. Production host `https://imbawallet.com` (no sandbox).

    - Human docs: `https://api-docs.imbawallet.com` (guides + FAQ)
    - Authenticate with `POST /auth/v1/partner/token` (assertion JWT), then call
      `POST /api/partner/<function>` with `Authorization: Bearer <access_token>`
      and a JSON body. Resource ids are body fields, not URL segments.
    - Amounts are decimal strings.
    - Response timestamps are UTC RFC 3339 with `Z`.
    - Request time fields accept RFC 3339 or unix seconds (not milliseconds).
    - Catalog calls (`/api/partner/gift_offers`, `/api/partner/esim_offers`,
      `/api/partner/card_products`) are live availability and the live USDT price.
      There is no `/quote` or `/availability` path.
    - Order lookup: `POST /api/partner/document_get`. Secrets via product calls
      after fulfillment (card JWE, gift `epin`, eSIM LPA) — not in webhooks
      except `card.otp`.
    - Not in v1: purchase refund/cancel, card unfreeze, card replacement,
      card merchant transaction history.
  contact:
    name: IMBA Partner Support
    email: support@imbawallet.com
  license:
    name: Proprietary
    url: https://imbawallet.com
servers:
  - url: https://imbawallet.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Assertion JWT → access token
  - name: Balance
    description: Partner settlement balance
  - name: Deposit
    description: Sticky USDT TRC-20 deposit address
  - name: Withdrawals
    description: USDT withdrawals from partner balance
  - name: Cards
    description: Card catalog, issue, list, secrets, topup, freeze
  - name: eSIM
    description: eSIM offers, purchase, topup
  - name: Gift cards
    description: Gift offers and purchases
  - name: Batch
    description: Mixed create cart (best-effort per item)
  - name: Documents
    description: Poll async documents by ext_id
  - name: Reconciliation
    description: Ledger lines for partner books
  - name: KYT
    description: Crypto-address screening, quotes and owned check history
paths:
  /api/partner/kyt_check:
    post:
      tags:
        - KYT
      summary: Screen a crypto address
      description: >-
        Scope kyt:check. A new check reserves the current quoted USDT price.
        Returns HTTP 200, initially status=processing; poll kyt_check_get.
        Reusing ext_id returns the existing tenant check without another charge.
        Keep the same network/address for that ext_id. A completed cached result
        may be returned at price_usdt=0; refresh=true bypasses the address
        cache, but not ext_id replay. KYT does not itself approve or reject
        deposits or withdrawals.
      operationId: createPartnerKytCheck
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - network
                - address
              properties:
                network:
                  $ref: '#/components/schemas/KytNetwork'
                address:
                  type: string
                ext_id:
                  type: string
                refresh:
                  type: boolean
                  default: false
      responses:
        '200':
          description: Created, in-flight, replayed or cached check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KytCheckResponse'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
components:
  schemas:
    KytNetwork:
      type: string
      enum:
        - tron_usdt
        - eth
        - btc
    KytCheckResponse:
      type: object
      required:
        - id
        - status
        - network
        - address
        - price_usdt
        - cached
        - created_at
      additionalProperties: true
      properties:
        id:
          type: integer
          format: int64
        status:
          type: string
          description: Usually processing, completed or failed
        network:
          $ref: '#/components/schemas/KytNetwork'
        address:
          type: string
        price_usdt:
          type: string
        cached:
          type: boolean
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
        error_code:
          type: string
        risk_score:
          type: number
        severity:
          type: string
        severity_ui:
          type: string
        sanctions_hit:
          type: boolean
        dominant_risk_category:
          type: string
        provider_check_id:
          type: string
        report:
          type: object
          additionalProperties: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: insufficient_balance
        message:
          type: string
          description: Optional human-readable explanation; handle the stable error code
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token from POST /auth/v1/partner/token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.