---
title: "Register a scan"
method: POST
path: "/scan/register"
tags: ["scan"]
---

# Register a scan

`POST /scan/register`

## Request body

- ScanRequest
  - `scanName` string
  - `removeOffchain` boolean
  - `walletInteraction` 'off' | 'shared' | 'forced'
  - `trackingRule` ScanningPredicate
    - `predicate` string, required

## Response `200`

Identifier of a scan generated

- ScanId
  - `scanId` integer

## Other responses

- `400` — Bad request
- `default` — Error

---

[API](https://skmtc.dev/ergoplatform/apis/ergo-node-api.md) · [All operations](https://skmtc.dev/ergoplatform/apis/ergo-node-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ergoplatform/ergo-node-api/revisions/a731602272c6/schema)