Skip to main content
POST
security.file.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
hash
string
required

MD5, SHA-1 or SHA-256 content hash, in hexadecimal.

Pattern: ^(?:[a-f0-9]{32}|[a-f0-9]{40}|[a-f0-9]{64})$

Response

The result

hash
string
required

The content hash checked.

verdict
enum<string>
required

Malicious when at least 3 engines flag it; suspicious with any other flag; clean means no flag, not proof of safety.

Available options:
clean,
suspicious,
malicious
flaggedBy
number
required

Engines flagging the file as malicious or suspicious.

sources
number
required

Engines that supplied a verdict; timed out and unsupported engines excluded.

sha256
string

SHA-256 content hash, when known.

sha1
string

SHA-1 content hash, when known.

md5
string

MD5 content hash, when known.

sizeBytes
number

File size in bytes.

fileType
string

File type, when known.

analysedAt
string

When the file was analysed, ISO 8601.