> ## 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.

# Add an annotation to a case

> Adds to the case a victim with evidence or a destination of the funds, obtained from
`GET /v1/scam/{chain}/{addr}/victims`. It does not change the case graph: annotating does not trace or expand.

The body is `{chain, address, role, source, evidence?, offramp_candidate?, label?, summary?}`:
- `role`: `victim` or `destination`;
- `source`: `{analysis, subject}`, with `analysis` equal to `scam_victims` and `subject` the analyzed address;
- `evidence`: only for a victim, and mandatory. Each `evidence[].kind` must be `signature_drain`,
 `approval_drain`, `account_executed`, `third_party_unresolved` or `case_loss_tx`, and `tx` is the transaction
 hash or `null`. Up to 25 items;
- `offramp_candidate`: only for a destination;
- `label` and `summary`: optional, up to 160 and 400 characters.

`address` and `source.subject` must be EVM addresses on a supported network; otherwise the response is `400`. A
victim without victim evidence (for example, a pattern indicator or an unqualified counterparty) returns `400`,
as does a destination with `evidence`. The server validates the shape of the evidence but does not rerun the
analysis: the victim status is supported by the cited evidence, not by the annotation.

The server fills in `added_at`, `updated_at`, `added_by`, `via` and `source.recorded_seq`, the latest query of
that analysis recorded in the case (or `null`). Adding the same address again, with the same role and the same
analysis, updates the annotation and keeps its `added_at`. The limit is 500 annotations per case.

The response is `{ok, token, annotation, annotations}`. Edit permission is required: a case shared for viewing
receives `403` with `error: "case_read_only"`, a read-only role or API key receives `403` with
`error: "read_only"`, and a case the caller cannot view returns `404`. The addition is recorded in the annotation
log and in the evidence package.

**Cost:** free.



## OpenAPI

````yaml /openapi.en.json post /v1/cases/{token}/annotations
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}/annotations:
    post:
      tags:
        - Cases
      summary: Add an annotation to a case
      description: >-
        Adds to the case a victim with evidence or a destination of the funds,
        obtained from

        `GET /v1/scam/{chain}/{addr}/victims`. It does not change the case
        graph: annotating does not trace or expand.


        The body is `{chain, address, role, source, evidence?,
        offramp_candidate?, label?, summary?}`:

        - `role`: `victim` or `destination`;

        - `source`: `{analysis, subject}`, with `analysis` equal to
        `scam_victims` and `subject` the analyzed address;

        - `evidence`: only for a victim, and mandatory. Each `evidence[].kind`
        must be `signature_drain`,
         `approval_drain`, `account_executed`, `third_party_unresolved` or `case_loss_tx`, and `tx` is the transaction
         hash or `null`. Up to 25 items;
        - `offramp_candidate`: only for a destination;

        - `label` and `summary`: optional, up to 160 and 400 characters.


        `address` and `source.subject` must be EVM addresses on a supported
        network; otherwise the response is `400`. A

        victim without victim evidence (for example, a pattern indicator or an
        unqualified counterparty) returns `400`,

        as does a destination with `evidence`. The server validates the shape of
        the evidence but does not rerun the

        analysis: the victim status is supported by the cited evidence, not by
        the annotation.


        The server fills in `added_at`, `updated_at`, `added_by`, `via` and
        `source.recorded_seq`, the latest query of

        that analysis recorded in the case (or `null`). Adding the same address
        again, with the same role and the same

        analysis, updates the annotation and keeps its `added_at`. The limit is
        500 annotations per case.


        The response is `{ok, token, annotation, annotations}`. Edit permission
        is required: a case shared for viewing

        receives `403` with `error: "case_read_only"`, a read-only role or API
        key receives `403` with

        `error: "read_only"`, and a case the caller cannot view returns `404`.
        The addition is recorded in the annotation

        log and in the evidence package.


        **Cost:** free.
      operationId: add_annotation_v1_cases__token__annotations_post
      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: 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.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnotationCreate'
      responses:
        '200':
          description: Successful response.
          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:
    AnnotationCreate:
      properties:
        chain:
          type: string
          title: Chain
        address:
          type: string
          title: Address
        role:
          type: string
          title: Role
        source:
          $ref: '#/components/schemas/Source'
        evidence:
          items:
            $ref: '#/components/schemas/Evidence'
          type: array
          maxItems: 25
          title: Evidence
        offramp_candidate:
          type: boolean
          title: Offramp Candidate
          default: false
        label:
          anyOf:
            - type: string
              maxLength: 160
            - type: 'null'
          title: Label
        summary:
          anyOf:
            - type: string
              maxLength: 400
            - type: 'null'
          title: Summary
      type: object
      required:
        - chain
        - address
        - role
        - source
      title: AnnotationCreate
    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
    Source:
      properties:
        analysis:
          type: string
          title: Analysis
        subject:
          type: string
          title: Subject
      type: object
      required:
        - analysis
        - subject
      title: Source
    Evidence:
      properties:
        kind:
          type: string
          title: Kind
        tx:
          anyOf:
            - type: string
            - type: 'null'
          title: Tx
      type: object
      required:
        - kind
      title: Evidence
    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.