Saltar al contenido principal
POST
Start an asset scan with optional webhook callback

Descripción general

Inicia un Asset Scan (escaneo de un asset). De forma opcional, puedes indicar el slug de una organización para activar la detección de suplantación de marca, y una URL de callback para recibir los resultados cuando termine el escaneo.

Autorizaciones

X-API-KEY
string
header
requerido

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.

Cuerpo

application/json
asset
string
requerido

The asset URL or content to scan

organizationSlug
string

Optional: Org slug for brand impersonation & visual similarity rules

mode
enum<string>
predeterminado:full

Scan mode

Opciones disponibles:
fast,
full
callbackUrl
string<uri>

HTTPS URL to receive scan results when complete

Respuesta

Successful response

assetId
number
requerido

The asset ID

workflowId
string
requerido

The Temporal workflow ID for tracking scan progress

organizationId
number | null
requerido

Org ID (null if no org context)

scanId
number | null
requerido

Scan ID if created within timeout