Sign in
scan

Register a scan

post/scan/register

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /scan/register
  • Auth: API key in header api_key

Request body

scanNamestring
removeOffchainboolean
walletInteraction'off' | 'shared' | 'forced'

Example request

{
  "scanName": "Assets Tracker",
  "walletInteraction": "off",
  "removeOffchain": true,
  "trackingRule": {
    "predicate": "containsAsset",
    "assetId": "02dada811a888cd0dc7a0a41739a3ad9b0f427741fe6ca19700cf1a51200c96bf7"
  }
}

Response

Identifier of a scan generated

scanIdinteger

Changes

No recorded changes to this operation across all 9 revisions of this API.