Skip to main content
POST
URL Scan checks a URL against Encrata’s threat-detection signals and returns a verdict, risk score, and supporting indicators.

Authentication

Send your API key as Authorization: Bearer enc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.

Request

string
required
Set this value to url.
string
required
The URL to scan. A URL without http:// or https:// is scanned as http://.
boolean
Set to true to include STIX 2.1 output when available. Defaults to false.
Encrata never fetches private or internal addresses, such as 127.0.0.1 or 10.x.x.x. For those URLs the verdict is unknown and signals contains an ssrf signal: “The link resolves to a private or internal address and was not fetched.”

Example request

Example response

This is the full response for the example request. Fields that don’t apply to a URL are omitted. For example, tls is missing because the page is served over plain HTTP, and credits is 0 because this URL had been scanned before. A first scan returns 1.

How the verdict is decided

Start with verdict. signals lists the evidence behind it. When a link can’t be reached or returns an error page, weak signs that add up, or reports for other links on the same site, give suspicious with low confidence instead of unknown.
Page analysis is static. Encrata doesn’t run the page’s scripts, so a phishing page built entirely in JavaScript can scan as clean unless a reputation source lists it.

Response

boolean
true when the scan completed.
string
Human-readable summary of the verdict, such as Malicious content detected. See Malware Scan for every message.
object
The URL scan result.
See Malware Scan for fields shared with other scan kinds.

Errors

Errors use the same envelope as successful responses, with success set to false. Branch on result.code. message is a sentence you can show to users. The response panel shows an example of each status.

Credits

A scan costs 1 credit, including a link that can’t be reached. Scanning the same URL again doesn’t charge you twice: the response has credits: 0.