# Private ThreatScan WS

The flow for quickscan ws is as follows:

* Register the token using auth\_token\_register event
* Using the token, send an event to perform a threatscan

1\. WebSocket API Documentation

* **URL:** `api-ws.solidityscan.com`
* **Protocol:** wss
* **Description:** This request requires authorization. The bearer token is sent in the `auth_token`request parameter.

Step 1. Auth Token Registration Description: The first step is to register with your auth token to generate an UUID.

{% tabs %}
{% tab title="Auth Token Register" %}

```
{
    "action": "message",
    "payload": {
        "type": "auth_token_register",
        "body": {
            "auth_token": "{Your_Auth_Token}"
        }
    }
}
```

{% endtab %}

{% tab title="Auth Token Register Ack" %}

```
{
    "type": "auth_token_register",
    "request_uuid": "Your_UUID",
    "payload": {
        "message": "Auth token registered."
    },
    "event_timestamp": "2024-04-19 11:37:17.854547"
}
```

{% endtab %}
{% endtabs %}

* **contract\_address**: The address of the contract to be scanned.
* **contract\_platform**: The platform which the contract belongs to.
* **contract\_chain**: The chain which the contract belongs to.

{% tabs %}
{% tab title="Private ThreatScan Initiate" %}

```
{
    "action": "message",
    "payload": {
        "type": "private_threat_scan_initiate",
        "body": {
            "contract_address": "0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contract_platform": "etherscan",
            "contract_chain": "mainnet"
        }
    }
}
```

{% endtab %}

{% tab title="ThreatScan Response" %}

````
```postman_json
{
    "type": "quick_scan_status",
    "request_uuid": "7b01a6f0f9e35feb448f1ce66f7b78e3",
    "payload": {
        "scan_id": "5bb187534473eb2e",
        "scan_status": "scan_done",
        "project_id": "3dd7c8c2f34eeeba94537ad4c7ee8901",
        "scan_details": {
            "compilerversion": "v0.8.23+commit.f704f362",
            "connection_id": "",
            "contract_address": "0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contract_chain": "mainnet",
            "contract_implementation_address": "",
            "contract_platform": "etherscan",
            "contract_url": "https://etherscan.io/address/0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contractname": "TRIUMPH",
            "currency": "ETH",
            "evmversion": "Default",
            "is_quick_scan": true,
            "licensetype": "MIT",
            "multi_file_scan_status": "scan_done",
            "multi_file_scan_summary": {
                "issue_severity_distribution": {
                    "critical": 5,
                    "gas": 89,
                    "high": 0,
                    "informational": 37,
                    "low": 6,
                    "medium": 7
                },
 .......
````

{% endtab %}
{% endtabs %}

{% file src="<https://4103464763-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FaqKivgb07WQWzl1XsCC9%2Fuploads%2Fgit-blob-a694277b88f9a50e53f480647ccfb077cd5ed141%2Fresponse.json?alt=media>" %}