Project Quick Scan

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

Request

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

Response

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

Step 2. Now send the scan message a sample message Request & Response is shared below:

Payload

{
    "action": "message",
    "payload": {
        "type": "private_project_quick_scan_initiate",
        "body": {
            "provider": "github",
            "project_url": "https://github.com/Shashank-In/SmartContract",
            "project_name": "SolidityScan",
            "project_type": "new",
            "project_branch": "main",
            "recur_scans": false,
            "project_visibility": "public",
            "skip_file_paths": []
        }
    }
}

Response

{
    "type": "quick_scan_status",
    "request_uuid": "",
    "payload": {
        "scan_id": "7c5c28fbb8b6c1f7",
        "scan_status": "scan_done",
        "project_id": "5a2095d0a980e5009da7f8a3e60dac77",
        "scan_details": {
            "is_latest_scan": false,
            "webhook_enabled": false,
            "file_url_list": null,
            "multi_file_scan_status": "scan_done",
            "multi_file_scan_summary": {
                "issue_severity_distribution": {
                    "informational": 6,
                    "low": 9,
                    "medium": 2,
                    "high": 1,
                    "critical": 5,
                    "gas": 13
                },
                "scan_time_taken": 6,
                "score_v2": "0.50",
                "lines_analyzed_count": 44,
                "threat_score": "78.95"
            },
            "project_branch": "main",
            "project_id": "5a2095d0a980e5009da7f8a3e60dac77",
            "project_name": "SolidityScan",
            "project_url": "https://github.com/Shashank-In/SmartContract",
            "scan_id": "7c5c28fbb8b6c1f7",
            "scan_init_time": "2024-11-06T04:42:57.782390",
            "scan_status": "scan_done",
            "scan_status_err_msg": null,
            "scan_type": "project",
            "quick_scan_file_details": [
                {
                    "issue_id": "QUICK_SCAN_PRESENCE_OF_MINTING_FUNCTION",
                    "issue_name": "PRESENCE OF MINTING FUNCTION",
                    "issue_description": "<p>The contract can mint new tokens. The <code>_mint</code> functions was detected in the contracts.</br>Mint functions are used to create new tokens and transfer them to the user\u2019s/owner\u2019s wallet to whom the tokens are minted. This increases the overall circulation of the tokens.</p>",
                    "issue_status": "fail",
                    "issue_dynamic_desc": "The contract can mint new tokens.",
                    "issue_code_findings_enabled": true,
                    "findings": [
...

The JSON of the scan data sample can be found below.

16KB

response.json