Submit a URL to be scanned for malware. This service is asynchronous and requires a callback URL.

Request
Security:
st_portal_auth
(write:scan)
Request Body schema: application/json
url
required
string <url> (URL) [ 7 .. 255 ] characters ^(https?):\/\/[-a-zA-Z0-9+&@#\/%?=~_|!:,.;]*[...
sourceScanId
required
string (SourceScanId)

The source system's scan ID.

callbackUrl
required
string (CallbackUrl)

The URL that the WRM system will call with the scan results once completed.

callbackAuthSignature
required
string (CallbackSignature)

An authentication signature that will be provided back to the callbackUrl endpoint once results are ready.

sourceSystem
string

The name of the source system. Used to identify which system the request came from.

merchantName
required
string

The name of the merchant for the scan request.

sourceMerchantId
required
string

The source system's unique identifier for the merchant.

wrmMerchantId
string

WRM's unique identifier for the merchant.

notificationEmail
string

Optional email that will be notified once the scan has completed.

Responses
200

successful operation

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

404

Not Found. The specified resource (or resource referred to by id) was not found

405

Method Not Allowed. The API was accessed with the wrong method

429

Too Many Requests. The API is rate-limited. Wait and try your request again.

500

Internal Server Error. An unexpected error has occurred. This may be due to a transient error. Retry the request and if the issue persists, please contact support.

503

Service Unavailable. The service is temporarily unavailable. Try your request later.

Callbacks
postAsynchronous response with the results of the malware scan
post/wrm/v1/scans/malware/url/submit
Request samples
application/json
{
  • "url": "https://www.vikingcloud.com/",
  • "sourceScanId": 2,
  • "callbackUrl": "string",
  • "callbackAuthSignature": "string",
  • "sourceSystem": "string",
  • "merchantName": "string",
  • "sourceMerchantId": "string",
  • "wrmMerchantId": "string",
  • "notificationEmail": "string"
}
Response samples
application/json
{
  • "message": "Field \"name\" cannot be null",
  • "status": 400,
  • "error": "Bad Request",
  • "timestamp": 1413315159949,
  • "exception": "org.springframework.web.server.ResponseStatusException",
  • "path": "/merchants/1"
}
Callback payload samples
POST: Asynchronous response with the results of the malware scan
application/json
{
  • "scanResultDetailList": [
    ],
  • "scanCompleteTime": "2019-08-24T14:15:22Z",
  • "overallStatusOfScan": "CLEAN",
  • "sourceScanId": 2,
  • "wrmScanId": "string"
}