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

Headers

​
authorization
string
required

Body

application/json
​
submitted_url
string
required
​
device
enum<string>
default:DESKTOP
Available options:
DESKTOP,
MOBILE
​
user_agent
string | null
​
http_referer
string | null
​
width
integer | null
​
height
integer | null
​
waiting_time
integer
default:5
Required range: 3 <= x <= 15
​
scanned_from
string
default:DEFAULT
​
private_scan
boolean
default:false
​
submitter_tags
string[]
​
origin
enum<string>
default:API
Available options:
USER,
API,
TELEGRAM

Response

Successful Response

​
id
string
required

Unique auto-generated scan identifier.

​
submitted_url
string
required

Original URL submitted for scanning.

​
device
enum<string>
required

Device type used for the scan simulation (DESKTOP or MOBILE).

Available options:
DESKTOP,
MOBILE
​
user_agent
string | null
required

User agent string used to simulate the browser environment.

​
scanned_from
string
required

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

​
origin
enum<string>
required

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

Available options:
USER,
API,
TELEGRAM
​
width
integer
required

Viewport width in pixels used during the scan.

​
height
integer
required

Viewport height in pixels used during the scan.

​
private_scan
boolean
required

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

​
status
enum<string>
required

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

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

ISO 8601 timestamp when the scan was submitted.

​
domain
string | null

Extracted domain from the submitted URL.

​
target_url
string | null

Final destination URL after following all redirects.

​
protocol
string | null

Protocol used (HTTP or HTTPS).

​
http_referer
string | null

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

​
nsfw
boolean | null
default:false

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

​
submitter_tags
string[] | null

User-defined tags for organizing and categorizing scans.

​
error_code
string | null

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