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

# Suspicious activity report draft

> Returns a sealed draft suspicious activity report for the case, for the analyst to download and complete.
blockgence does not submit anything.
- `ros`: the suspicious transaction report of the Argentine financial intelligence unit (UIF). Its fields cite UIF
 Resolution 49/2024, Law 25.246 and the UIF instructions.
- `str`: a generic report with the goAML structure and FATF Recommendation 20. It is not the official form of any
 unit.

It is built from the saved snapshot, like the evidence. `tx` selects the transactions of the reported operation:
start, end and amount come only from them, and only if each one is a simple transfer. Without `tx`, those fields
are left blank; if a selected transaction is an aggregated edge, a crossing, a swap or moves value in several
rows, they are also left blank and `selection.issues` states the reason.

What it includes:
- `sections`: the form fields, in the order of the instructions, each with `status` `from_case` (the value comes
 from the case) or `to_complete` (left blank) and the regulations that require it. Personal data and the
 decisions of the reporting entity are always left blank;
- `persons`: a blank template per person involved. A label, an ENS name or an entity never becomes a person;
- `amounts` (with `tx`): one line per asset, with the exact amount and the USD value at the date of each
 transaction. Different assets are not added together and the current price is never used;
- `deadlines` (`ros` with `tx`): the maximum filing deadline and whether it has passed;
- `operations`: one row per transfer of the case edges, in date order, up to 5,000 (`operations_truncated`);
- `indicators`: the case facts that correspond to the indicators of UIF Resolution 49/2024. They are observations
 and do not qualify the operation;
- `transactions` (`str` with `tx`): each transaction with the goAML structure;
- `case`, with `snapshot_sha256`, the sha256 of the snapshot behind the draft, plus `selection`, `facts`,
 `annotations`, `limitations` and `methodology`.

Errors: `400` if a transaction is not in the case, a hash is malformed or `format` is invalid; `404` if the caller
cannot view the case or `kind` is unknown; `409` if the case does not have a saved trace yet; `422` if the
snapshot is not a valid graph.

**Cost:** free.



## OpenAPI

````yaml /openapi.en.json get /v1/cases/{token}/report/{kind}
openapi: 3.1.0
info:
  title: blockgence API
  description: >-
    The **blockgence** API provides fund tracing, entity attribution and
    explainable risk screening across several

    networks, with the evidence behind every result.


    ### Authentication

    Every `/v1/*` route requires an **API key**, sent in the `X-API-Key: <key>`
    header or as

    `Authorization: Bearer <key>`. Your organization issues the key. The
    evidence verification routes

    (`/v1/evidence/*`) do not require a key.


    ### Credits and limits

    Each plan has a **per-minute request limit** and a **monthly credit
    allowance**. Each operation states its cost in

    credits. **Only successful responses (status below 400) are charged:** an
    error response is recorded with 0

    credits. Check your usage with `GET /v1/account`.


    ### Data that could not be read

    If the data source cannot read what you requested, the response is `503
    source_unavailable`, with no charge,

    stating the source, the network, the query, the reason and whether a retry
    is advisable. If an intermediate step

    fails, the response is 200 and declares it in `degraded_sources` and in the
    `coverage_gaps` of the node or edge:

    in those cases, missing data does not mean missing activity.


    ### Networks

    `ethereum`, `bsc`, `polygon`, `arbitrum`, `base` and `optimism`; plus `tron`
    for tracing, profile, funding, network

    probing and transactions. `GET /v1/chains` states what can be queried on
    each network, at no cost. The networks

    `monero`, `bitcoin`, `litecoin` and `solana` are recognized in `/screening`
    and `/address`, where the network is

    inferred from the address format. Any other network returns `400`: it is
    never replaced with Ethereum.
  contact:
    name: blockgence
    url: https://www.blockgence.com/
  version: 1.0.0
servers:
  - url: https://app.blockgence.com
    description: Production
security: []
tags:
  - name: Platform
    description: >-
      Available networks, what can be queried on each one, from which sources
      and under which methodology. No cost.
  - name: Tracing
    description: >-
      Fund-flow tracing and reads of an address or a transaction: a
      time-consistent graph in both directions, funding, counterparties,
      bridges, swaps, mixers, labels and on-chain data.
  - name: Screening
    description: >-
      Risk screening of an address, with a recommendation (allow, review or
      block), its reasons and its sources.
  - name: Contracts
    description: Contract inspection and simulation of a transaction before signing it.
  - name: Tokens
    description: Token profile, with its issuer, supply, holders and risk signals.
  - name: Compromise
    description: >-
      Compromise vector of a stolen wallet, that is, how control of the funds
      was lost.
  - name: Incidents
    description: >-
      Incident response for victims, hacks and scams: playbook, freeze requests
      to issuers, post-mortem and deliverables.
  - name: Copilot
    description: >-
      AI investigation copilot that answers in natural language and cites the
      evidence (SSE streaming).
  - name: Cases
    description: >-
      Investigation cases to save, share and export, with their evidence,
      activity and annotations.
  - name: Permissions
    description: >-
      Approvals, delegations and signatures that grant access to an address's
      funds (ERC-20, Permit2 and EIP-7702).
  - name: Guard
    description: Wallet and protocol monitoring, with alerts by webhook and email.
  - name: Travel Rule
    description: >-
      Travel Rule without third-party connections: ownership challenge,
      counterparty, reconciliation and validation of IVMS101 messages.
  - name: Audit
    description: >-
      Smart contract audits, with the status, findings and evidence of each
      audit.
  - name: Evidence
    description: >-
      Verification of sealed evidence, with the signing public key and
      timestamps. No API key or charge required.
  - name: Monero
    description: >-
      Public profile of a Monero transaction and verification of a payment
      proof. Monero does not publish senders or amounts, so it is not traced.
  - name: Account
    description: Usage and limits of your API key.
  - name: Icons
    description: Entity logos to render graphs in your own interface. No cost.
  - name: Service
    description: Service status.
paths:
  /v1/cases/{token}/report/{kind}:
    get:
      tags:
        - Cases
      summary: Suspicious activity report draft
      description: >-
        Returns a sealed draft suspicious activity report for the case, for the
        analyst to download and complete.

        blockgence does not submit anything.

        - `ros`: the suspicious transaction report of the Argentine financial
        intelligence unit (UIF). Its fields cite UIF
         Resolution 49/2024, Law 25.246 and the UIF instructions.
        - `str`: a generic report with the goAML structure and FATF
        Recommendation 20. It is not the official form of any
         unit.

        It is built from the saved snapshot, like the evidence. `tx` selects the
        transactions of the reported operation:

        start, end and amount come only from them, and only if each one is a
        simple transfer. Without `tx`, those fields

        are left blank; if a selected transaction is an aggregated edge, a
        crossing, a swap or moves value in several

        rows, they are also left blank and `selection.issues` states the reason.


        What it includes:

        - `sections`: the form fields, in the order of the instructions, each
        with `status` `from_case` (the value comes
         from the case) or `to_complete` (left blank) and the regulations that require it. Personal data and the
         decisions of the reporting entity are always left blank;
        - `persons`: a blank template per person involved. A label, an ENS name
        or an entity never becomes a person;

        - `amounts` (with `tx`): one line per asset, with the exact amount and
        the USD value at the date of each
         transaction. Different assets are not added together and the current price is never used;
        - `deadlines` (`ros` with `tx`): the maximum filing deadline and whether
        it has passed;

        - `operations`: one row per transfer of the case edges, in date order,
        up to 5,000 (`operations_truncated`);

        - `indicators`: the case facts that correspond to the indicators of UIF
        Resolution 49/2024. They are observations
         and do not qualify the operation;
        - `transactions` (`str` with `tx`): each transaction with the goAML
        structure;

        - `case`, with `snapshot_sha256`, the sha256 of the snapshot behind the
        draft, plus `selection`, `facts`,
         `annotations`, `limitations` and `methodology`.

        Errors: `400` if a transaction is not in the case, a hash is malformed
        or `format` is invalid; `404` if the caller

        cannot view the case or `kind` is unknown; `409` if the case does not
        have a saved trace yet; `422` if the

        snapshot is not a valid graph.


        **Cost:** free.
      operationId: case_report_v1_cases__token__report__kind__get
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
            title: Token
          description: >-
            Case token (`case_…`). If the caller cannot view the case, the
            response is `404`, the same as for a case that does not exist.
        - name: kind
          in: path
          required: true
          schema:
            type: string
            title: Kind
          description: >-
            Draft type: `ros` (suspicious transaction report for the Argentine
            UIF) or `str` (generic, with the goAML structure). Any other value
            returns `404`.
        - name: tx
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            title: Tx
          description: >-
            Hashes of the case transactions that make up the reported operation
            (0x and 64 hexadecimal characters), repeatable or comma-separated,
            up to 200. Start, end and amount of the report come only from them.
        - name: format
          in: query
          required: false
          schema:
            type: string
            default: json
            title: Format
          description: >-
            Response format: `json` (default, the sealed document) or `md` (the
            document in Markdown, as a file, with the sha256 of the sealed JSON
            on the first line). Any other value returns `400`.
        - name: X-Case-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Case-Id
          description: >-
            Active case, optional: the token of a case you can view. The query
            is recorded in that case and also uses its own labels. A case that
            does not exist, was deleted or is no longer shared with you returns
            `400 case_unavailable` and the query is not run, with no charge.
      responses:
        '200':
          description: >-
            The sealed draft in JSON or, with `format=md`, the document in
            Markdown (`text/markdown`) as a file.
          content:
            application/json:
              schema: {}
        '401':
          description: The API key is missing, invalid or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: The monthly credits are exhausted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            The request does not have the expected shape; `detail` states which
            field to correct.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            The per-minute request limit was exceeded. Retry after the number of
            seconds in `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      title: Error
      description: >-
        Common shape of errors: a readable `detail` and, in many cases, an
        `error` with a stable code to recognize it without parsing the text.
      properties:
        detail:
          type: string
          description: What happened, in one sentence.
        error:
          type: string
          description: Stable error code, when there is one.
      required:
        - detail
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key in the `X-API-Key` header.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        The same API key as `Authorization: Bearer <key>`, as an alternative to
        `X-API-Key`.

````

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