Skip to main content
POST
/
v1
/
scan
Submit a New Scan
curl --request POST \
  --url https://api.urldna.io/v1/scan \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "submitted_url": "<string>",
  "scanned_from": "DEFAULT",
  "device": "DESKTOP",
  "user_agent": "<string>",
  "http_referer": "<string>",
  "width": 1920,
  "height": 1080,
  "waiting_time": 5,
  "private_scan": false,
  "submitter_tags": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "submitted_url": "<string>",
  "domain": "<string>",
  "target_url": "<string>",
  "protocol": "<string>",
  "device": "DESKTOP",
  "user_agent": "<string>",
  "http_referer": "<string>",
  "nsfw": true,
  "scanned_from": "DEFAULT",
  "origin": "API",
  "width": 123,
  "height": 123,
  "private_scan": true,
  "status": "PENDING",
  "submitted_date": "2023-11-07T05:31:56Z",
  "submitter_tags": [
    "<string>"
  ],
  "error_code": "<string>"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
submitted_url
string
required

Complete URL to scan (must include protocol: http:// or https://).

​
scanned_from
enum<string>
default:DEFAULT

Geographic location from which to perform the scan. Enables geo-specific content testing. PREMIUM users only.

Available options:
DEFAULT,
AU,
BE,
CA,
CH,
DE,
ES,
FR,
GB,
GR,
HU,
ID,
IT,
JP,
MX,
NL,
PT,
ZA,
TR,
US
​
device
enum<string>
default:DESKTOP

Device type to simulate during scanning.

Available options:
DESKTOP,
MOBILE
​
user_agent
string

Custom user agent string. Retrieve available options from GET /v1/user-agents endpoint.

​
http_referer
string

HTTP Referer header value to simulate traffic from a specific source page.

​
width
integer
default:1920

Viewport width in pixels. See GET /v1/viewports for recommended dimensions.

​
height
integer
default:1080

Viewport height in pixels. See GET /v1/viewports for recommended dimensions.

​
waiting_time
integer
default:5

Wait time in seconds before capturing scan results. Allows JavaScript-heavy pages to fully render.

​
private_scan
boolean
default:false

When true, scan results are private and accessible only to the submitting user.

​
submitter_tags
string[]

Custom tags for organizing and filtering scans. PREMIUM users only.

Response

Scan successfully queued for processing.

Complete scan metadata including submission details, configuration parameters, and processing status.

​
id
string

Unique auto-generated scan identifier.

​
submitted_url
string

Original URL submitted for scanning.

​
domain
string

Extracted domain from the submitted URL.

​
target_url
string

Final destination URL after following all redirects.

​
protocol
string

Protocol used (HTTP or HTTPS).

​
device
enum<string>

Device type used for the scan simulation.

Available options:
DESKTOP,
MOBILE
​
user_agent
string

User agent string used to simulate the browser environment.

​
http_referer
string

HTTP Referer header value indicating the originating page for the request.

​
nsfw
boolean

Indicates whether the page contains Not Safe For Work (NSFW) content such as nudity or adult material.

​
scanned_from
enum<string>

Country code from which the scan was initiated. Available for PREMIUM users only.

Available options:
DEFAULT,
AU,
BE,
CA,
CH,
DE,
ES,
FR,
GB,
GR,
HU,
ID,
IT,
JP,
MX,
NL,
PT,
ZA,
TR,
US
​
origin
enum<string>

Indicates whether the scan was submitted programmatically via API or manually by a user.

Available options:
API,
USER
​
width
number

Viewport width in pixels used during the scan.

​
height
number

Viewport height in pixels used during the scan.

​
private_scan
boolean

When true, scan results are only accessible to the submitting user.

​
status
enum<string>

Current scan status. PENDING and RUNNING are transient states; DONE and ERROR are terminal states.

Available options:
PENDING,
RUNNING,
DONE,
ERROR
​
submitted_date
string<date-time>

ISO 8601 timestamp when the scan was submitted.

​
submitter_tags
string[]

User-defined tags for organizing and categorizing scans.

​
error_code
string

Error code when scan status is ERROR, indicating the reason for failure.