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

# Incident fund returns

> Analyzes what was returned after an incident and classifies it as a whitehat rescue, a negotiated return, a
partial return or no return, against the terms of the SEAL Safe Harbor agreement read on-chain at the exploit
date or against the bounty offered in an on-chain message from the protocol. It is context: it never removes the
exploit label.

Request body:
- `chain`: EVM network of the incident (defaults to `ethereum`);
- `exploit_txs`: transactions of the incident, from 1 to 10, on the same network. They are decoded as in
 `GET /v1/decode/{chain}/{hash}`;
- `holders`: other accounts that held funds from the incident, in groups (up to 10 groups of up to 5
 addresses). Each group is a unit;
- `protocol_addresses`: up to 10 protocol addresses, `{address, role, source}`, with `role` set to `recovery`
 (receives returns) or `protocol`. `source` is mandatory and is cited;
- `incident_block`: block of the reference malicious exploit, if the transactions belong to a rescue that
 front-ran it;
- `window_days`: days after the exploit in which returns are searched, from 1 to 180 (defaults to 30).

The units are the attacker's group of accounts, each account the attacker paid in the transaction, each group of
`holders` and each intermediary that returned funds on its own (`unit: "relay"`). Each unit includes
`received`, `returned` (what was sent to an address on the protocol side, with its `role` and its source),
`ratio`, `expected_ratio` with `expected_basis` (`safe_harbor`, `offered_in_message` or `full`), `class`
(`whitehat-rescue`, `negotiated-return`, `partial-return` or `no_return`), `kept_assets`, `candidates` (outflows
to unconfirmed destinations, which are not returns), `safe_harbor_compliant`, `whitehat_likelihood` and
`reasons`. The top level includes `victims`, `stolen_usd`, `safe_harbor`, `summary` (`returned_usd`,
`recovered_ratio`, `classes`, `verdict`), `not_evaluated`, `not_covered` and `degraded_sources`.

An invalid hash or address, a group of more than 5 addresses or a protocol address without a source returns 400,
at no charge. If no exploit transaction can be read, the response is 503 at no charge; if some fail, they are
declared and the analysis continues with the rest.

**Cost:** 40 credits base. Some operations charge less when they reuse a saved result; never more.



## OpenAPI

````yaml /openapi.en.json post /v1/returns
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/returns:
    post:
      tags:
        - Incidents
      summary: Incident fund returns
      description: >-
        Analyzes what was returned after an incident and classifies it as a
        whitehat rescue, a negotiated return, a

        partial return or no return, against the terms of the SEAL Safe Harbor
        agreement read on-chain at the exploit

        date or against the bounty offered in an on-chain message from the
        protocol. It is context: it never removes the

        exploit label.


        Request body:

        - `chain`: EVM network of the incident (defaults to `ethereum`);

        - `exploit_txs`: transactions of the incident, from 1 to 10, on the same
        network. They are decoded as in
         `GET /v1/decode/{chain}/{hash}`;
        - `holders`: other accounts that held funds from the incident, in groups
        (up to 10 groups of up to 5
         addresses). Each group is a unit;
        - `protocol_addresses`: up to 10 protocol addresses, `{address, role,
        source}`, with `role` set to `recovery`
         (receives returns) or `protocol`. `source` is mandatory and is cited;
        - `incident_block`: block of the reference malicious exploit, if the
        transactions belong to a rescue that
         front-ran it;
        - `window_days`: days after the exploit in which returns are searched,
        from 1 to 180 (defaults to 30).


        The units are the attacker's group of accounts, each account the
        attacker paid in the transaction, each group of

        `holders` and each intermediary that returned funds on its own (`unit:
        "relay"`). Each unit includes

        `received`, `returned` (what was sent to an address on the protocol
        side, with its `role` and its source),

        `ratio`, `expected_ratio` with `expected_basis` (`safe_harbor`,
        `offered_in_message` or `full`), `class`

        (`whitehat-rescue`, `negotiated-return`, `partial-return` or
        `no_return`), `kept_assets`, `candidates` (outflows

        to unconfirmed destinations, which are not returns),
        `safe_harbor_compliant`, `whitehat_likelihood` and

        `reasons`. The top level includes `victims`, `stolen_usd`,
        `safe_harbor`, `summary` (`returned_usd`,

        `recovered_ratio`, `classes`, `verdict`), `not_evaluated`, `not_covered`
        and `degraded_sources`.


        An invalid hash or address, a group of more than 5 addresses or a
        protocol address without a source returns 400,

        at no charge. If no exploit transaction can be read, the response is 503
        at no charge; if some fail, they are

        declared and the analysis continues with the rest.


        **Cost:** 40 credits base. Some operations charge less when they reuse a
        saved result; never more.
      operationId: fund_returns_v1_returns_post
      parameters:
        - 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/ReturnsRequest'
      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'
        '503':
          description: >-
            `source_unavailable`: the data source could not read what was
            requested. No credits are charged. If an intermediate step fails,
            the response is 200 and declares it in `degraded_sources`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceUnavailable'
      security:
        - APIKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    ReturnsRequest:
      properties:
        chain:
          type: string
          title: Chain
          default: ethereum
        exploit_txs:
          items:
            type: string
          type: array
          maxItems: 10
          minItems: 1
          title: Exploit Txs
        holders:
          items:
            items:
              type: string
            type: array
          type: array
          maxItems: 10
          title: Holders
        protocol_addresses:
          items:
            $ref: >-
              #/components/schemas/backend__modules__incident__routes__ProtocolAddress
          type: array
          maxItems: 10
          title: Protocol Addresses
        incident_block:
          anyOf:
            - type: integer
            - type: 'null'
          title: Incident Block
        window_days:
          type: integer
          title: Window Days
          default: 30
      type: object
      required:
        - exploit_txs
      title: ReturnsRequest
    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
    SourceUnavailable:
      type: object
      title: SourceUnavailable
      description: >-
        The data source could not read what was requested. No credits are
        charged. Missing data does not mean the address is risk-free or has no
        activity.
      properties:
        error:
          type: string
          enum:
            - source_unavailable
        detail:
          type: string
          description: What failed, where, and whether a retry is advisable.
        source:
          type: string
          description: >-
            Source that could not respond, for example `etherscan` or
            `blockscout`.
        chain:
          type: string
        primitive:
          type: string
          description: blockgence read that did not complete.
        operation:
          type: string
          description: Specific query to the source.
        target:
          type: string
          description: What was queried (address or transaction), abbreviated.
        reason:
          type: string
          description: >-
            Stable reason, for example `rate_limited`, `timeout` or
            `upstream_error`.
        retryable:
          type: boolean
        http_status:
          type:
            - integer
            - 'null'
        retry_after:
          type:
            - integer
            - 'null'
          description: >-
            Seconds to wait before retrying; also sent in the `Retry-After`
            header.
        upstream_message:
          type:
            - string
            - 'null'
        source_fault:
          type: boolean
          description: >-
            Whether the failure came from the source or from a limit of the
            query itself.
        failure_cause:
          type: string
          description: Cause of the failure, in one sentence.
      required:
        - error
        - detail
        - source
        - reason
        - retryable
    backend__modules__incident__routes__ProtocolAddress:
      properties:
        address:
          type: string
          title: Address
        role:
          type: string
          title: Role
          default: recovery
        source:
          type: string
          title: Source
      type: object
      required:
        - address
        - source
      title: ProtocolAddress
    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.