Skip to main content
POST
Start an asset scan with optional webhook callback

Overview

Initiate an asset scan. Optionally provide an organization slug to enable brand impersonation detection, and a callback URL to receive the results once the scan completes.

Authorizations

X-API-KEY
string
header
required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json
asset
string
required

The asset URL or content to scan

organizationSlug
string

Optional: Org slug for brand impersonation & visual similarity rules

mode
enum<string>
default:full

Scan mode

Available options:
fast,
full
callbackUrl
string<uri>

HTTPS URL to receive scan results when complete

Response

Successful response

assetId
number
required

The asset ID

workflowId
string
required

The Temporal workflow ID for tracking scan progress

organizationId
number | null
required

Org ID (null if no org context)

scanId
number | null
required

Scan ID if created within timeout