POST
/
scan
curl --request POST \
  --url https://api.urldna.io/scan \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "submitted_url": "<string>",
  "scanned_from": "DEFAULT",
  "device": "DESKTOP",
  "user_agent": "<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>",
  "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>"
  ]
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
submitted_url
string
required

The URL to be scanned.

​
scanned_from
enum<string>
default:DEFAULT

The country from which the scan was initiated. Available only for PREMIUM users.

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

The type of device to simulate during the scan.

Available options:
DESKTOP,
MOBILE
​
user_agent
string

Custom user agent string for the scan request. See User Agents endpoints.

​
width
integer
default:1920

Viewport width in pixels. See Viewports endpoints.

​
height
integer
default:1080

Viewport height in pixels. See Viewports endpoints.

​
waiting_time
integer
default:5

Time in seconds to wait before capturing scan results.

​
private_scan
boolean
default:false

If true, the scan will not be publicly accessible.

​
submitter_tags
string[]

A list of any tags associated with the scan. Available only for PREMIUM users.

Response

200
application/json
Scan request successfully created.

Contains detailed information about the scan, including URL submission details, scan status, and various scan-related metadata.

​
id
string

Unique, autogenerated identifier for the scan.

​
submitted_url
string

The URL provided by the user to be scanned.

​
domain
string

The domain of the submitted URL.

​
target_url
string

The final URL after any redirection (if applicable).

​
protocol
string

The protocol of the URL, such as HTTP or HTTPS.

​
device
enum<string>

The type of device selected for the scan, either 'DESKTOP' or 'MOBILE'.

Available options:
DESKTOP,
MOBILE
​
user_agent
string

The user agent string associated with the device for simulating the browser environment.

​
nsfw
boolean

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

​
scanned_from
enum<string>

The country from which the scan was initiated. Available only for PREMIUM users.

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 via the API or by a user.

Available options:
API,
USER
​
width
number

The width of the viewport used during the scan in pixels.

​
height
number

The height of the viewport used during the scan in pixels.

​
private_scan
boolean

If true, the scan results are only accessible by the user who submitted the scan.

​
status
enum<string>

The current status of the scan. 'PENDING' and 'RUNNING' are intermediate states, while 'DONE' and 'ERROR' are final states.

Available options:
PENDING,
RUNNING,
DONE,
ERROR
​
submitted_date
string

The date and time when the scan was submitted.

​
submitter_tags
string[]

A list of any tags associated with the scan, submitted by the user.