CG Scanning API V2
latest
  • latest
  • 5.2.0
  • 5.3.0
HomeDocs
HomeDocs
latest
  • latest
  • 5.2.0
  • 5.3.0
  1. SAQ API
  • Scanning API
    • Getting Started
    • Authentication
    • Common Error Responses
    • Filtering Data
    • Authentication
      • User Confirmation
        • Confirm a User
        • Show confirmation form
      • User Invitation
        • Accept an invitation
        • Pre-Accept invitation check
      • Password Reset
        • Forgot Password
        • Reset Password
      • Impersonation
        • Impersonate user
        • Impersonate user
      • MFA
        • Check 2fa
        • Send SMS OTP
      • Sign in authentication
      • Sign in with recovery code
      • Sign out authentication
      • SSO Link login
    • Targets
      • List targets
      • Create Target
      • Show a target
      • Updates a target
      • Delete a target
      • Delete targets
    • Scans
      • Scan Histories
        • List of history for a scan
        • History details for a scan
      • Scan Hosts
        • List of hosts for a scan
        • Host details for a scan
      • Scan Vulnerabilities
        • List of vulnerabilities for a scan
        • Show vulnerability details
        • Statistics for a scan
      • List scans
      • Create Scan
      • Show a scan
      • Updates a scan
      • Delete a scan
      • Delete scans
      • Start a scan
      • Stop a scan
      • List upcoming scans
      • List recent scans that have been completed
      • List of the running scans
      • Create Scan from Wizard
    • Reports
      • List Reports
      • Show a report
      • Delete a report
      • Delete reports
      • Generates a report file
      • Downloads a report file
      • Check if a report file exists
      • Verifies file integrity by comparing hashes
    • Vulnerabilities
      • List of vulnerabilities
      • Vulnerability details
      • Total Vulnerabilities (widget)
      • Top Vulnerabilities (widget)
      • PCI Compliant (widget)
      • Send prompt about a given Vulnerability
      • Chat history about a given Vulnerability
    • Exceptions
      • List Exceptions
      • Create Exception
      • Update Exception
      • Show an exception
      • Delete an exception
      • Show exception details
      • Delete exceptions
      • Activate exceptions
      • Reset exceptions
      • Show the exceptions statistics
    • Schedules
      • List Schedules
      • Create Schedule
      • Updates a schedule
      • Show a schedule
      • Delete a schedule
      • Delete schedules
      • Calculate First Time Schedule Date
      • Calculate Next Schedule Dates
    • Webhooks
      • Deliveries
        • List all deliveries for a webhook
        • Get a delivery for a webhook
      • List all webhooks
      • Create a webhook
      • Show a webhook
      • Update a webhook
      • Delete a webhook
      • Activate a webhook
      • Deactivate a webhook
    • Advanced Reports
      • List Advanced Reports
      • Create an advanced report
      • Show an advanced report
      • Update an advanced report
      • Delete an advanced report
      • Delete advanced reports
      • Generates an advanced report file
      • Downloads an advanced report file
    • Audit
      • Get all events
      • Get event by id
    • Notifications
      • List Notifications
      • Show a notification
      • Delete a notification
      • Mark as read a notification
      • Mark as seen a notification
      • Mark as read all notifications
      • Mark as seen all notifications
    • Hosts
      • List of hosts
      • Host details
      • List of most vulnerable hosts
    • Scanners
      • List scanners
      • Create scanner
      • Show scanner
      • Update scanner
      • Delete scanner
      • List activated scanners
      • Activate scanner
      • Deactivate scanner
      • Update scanner app type
      • Assign a scanner to an organization
      • Verify a scanner
    • Port Lists
      • List port lists
      • Create a port list
      • Show a port list
      • Update a port list
      • Delete a port list
      • List activated port lists
      • Add a port range to a port list
      • Delete a port range to a port list
      • Activate a port list
      • Deactivate a port list
      • Updates the app_type of a port list
      • Sync the a port lists
    • User
      • User 2FA
        • Enable 2FA
        • Verify 2FA installation
        • Disable 2FA
        • Lookup phone number
        • Default 2FA method
        • Generate Recovery Codes
        • Get Recovery Codes
      • User Preferences
        • Get users notification preferences
        • Change users product
        • Enable user's event notification preference
        • Disable user's event notification preference
      • Get current user
      • Update current user
      • Change current user password
      • Get current user active plans (Not implemented yet)
      • Get organization members
      • Get current user products
      • Get current organization
      • Update current organization
      • Get subscriptions history
      • Change users product
      • Checks if authorization token is valid
      • Get current user permissions
      • Check if the user can be deleted
      • Delete my account
      • Generates a new access token
      • Revokes the current access token
      • Transfers all the resources from the user to another user
    • Organizations
      • Organization Subscriptions
        • Retrieves all subscriptions of organization
        • Retrieves all active subscriptions of organization
        • Show a subscription of organization
        • Update organization's subscription
        • Assign features to a subscription
        • Revoke features from a subscription
      • Subscribe to a plan
      • List organizations
      • Create Organization
      • List dependent subscriptions
      • Retrieve an organization
      • Update an organization
      • Delete an organization
      • Subscribe an organization to a plan
      • Unsubscribe an organization from a plan
      • Change users Organization
      • Export organizations
    • Users
      • List Users
      • Create User
      • Show User
      • Update User
      • Delete a User
      • Create Customer
      • Invite User
      • Resend Confirmation Instructions
      • Import Users
      • Check if a user can be deleted
      • Inherit all the resources from a user
      • Export all users to a CSV file
      • Set partner
      • Unset partner
    • Whitelabel Settings
      • Show the white label settings
      • Show the white label settings
      • Update white label settings
  • SAQ API
    • List all SAQs
      GET
    • Get SAQ (JSON) or Download SAQ (PDF)
      GET
    • List Available SAQ Types
      GET
    • Get SAQ Type Template
      GET
    • Create a New SAQ
      POST
    • Delete an SAQ
      DELETE
    • Clone an SAQ
      PUT
    • Approve an SAQ
      PUT
    • Set SAQ as a template
      PUT
  1. SAQ API

Get SAQ Type Template

Developing
GET
/saq/api/saqs/type_templates/{type}
Last modified:2025-10-31 11:44:15
Returns an empty, schema-correct payload for the given SAQ type—use it as a starting point for creating a new SAQ.

Request

Path Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/saq/api/saqs/type_templates/saq_a'
Response Response Example
{
    "data": {
        "uuid": null,
        "name": "SAQ A - 4.0.1",
        "saq_type": "saq_a",
        "owner": null,
        "content": {
            "parts": {
                "part2": {
                    "part_2_a": {
                        "p2_a_1": null,
                        "p2_a_2": null,
                        "p2_a_3": null,
                        "p2_a_4": null,
                        "p2_a_4_note": null
                    },
                    "part_2_b": {
                        "notes": [
                            {
                                "channel": null,
                                "note": null
                            },
                            {
                                "channel": null,
                                "note": null
                            },
                            {
                                "channel": null,
                                "note": null
                            }
                        ]
                    },
                    "part_2_c": {
                        "p2_c_1": null,
                        "p2_c_2": null
                    },
                    "part_2_d": {
                        "notes": [
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            },
                            {
                                "type": null,
                                "num_of_locations": null,
                                "locations": null
                            }
                        ]
                    },
                    "part_2_e": {
                        "notes": [
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            },
                            {
                                "name": null,
                                "version": null,
                                "pci_standard": null,
                                "reference": null,
                                "expiry_date": null
                            }
                        ],
                        "p2_e_1": null
                    },
                    "part_2_f": {
                        "notes": [
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            },
                            {
                                "service_name": null,
                                "description": null
                            }
                        ],
                        "p2_f_1": null,
                        "p2_f_2": null,
                        "p2_f_3": null
                    },
                    "part_2_g": {
                        "notes": [
                            {
                                "requirement": "Requirement 2"
                            },
                            {
                                "requirement": "Requirement 3"
                            },
                            {
                                "requirement": "Requirement 6"
                            },
                            {
                                "requirement": "Requirement 8"
                            },
                            {
                                "requirement": "Requirement 9"
                            },
                            {
                                "requirement": "Requirement 11"
                            },
                            {
                                "requirement": "Requirement 12"
                            }
                        ],
                        "name_of_service_assessed": null,
                        "not_applicable_req_reason": null,
                        "not_tested_req_reason": null
                    },
                    "part_2_h": {
                        "notes": [
                            {
                                "description": "saq_a.r_1"
                            },
                            {
                                "description": "saq_a.r_2"
                            },
                            {
                                "description": "saq_a.r_3"
                            },
                            {
                                "description": "saq_a.r_4"
                            },
                            {
                                "description": "saq_a.r_5"
                            },
                            {
                                "description": "saq_a.r_6"
                            },
                            {
                                "description": "saq_a.r_7"
                            }
                        ]
                    }
                },
                "part3": {
                    "part_3_pre": {
                        "notes": [
                            {
                                "affected": null,
                                "details": null
                            },
                            {
                                "affected": null,
                                "details": null
                            },
                            {
                                "affected": null,
                                "details": null
                            }
                        ],
                        "p3_pre_1": null,
                        "p3_pre_2": null,
                        "p3_pre_3": null
                    },
                    "part_3_a": {
                        "p3_a_1": null,
                        "p3_a_2": null,
                        "p3_a_3": null
                    },
                    "part_3_b": {
                        "signature": null,
                        "p3_b_1": null,
                        "p3_b_2": null,
                        "p3_b_3": null
                    },
                    "part_3_c": {
                        "signature_lead_qsa": null,
                        "signature_officer_qsa": null,
                        "p3_c_1": null,
                        "p3_c_2": null,
                        "p3_c_3": null,
                        "p3_c_4": null,
                        "p3_c_5": null,
                        "p3_c_6": null,
                        "p3_c_7": null,
                        "p3_c_8": null
                    },
                    "part_3_d": {
                        "p3_d_1": null,
                        "p3_d_2": null,
                        "p3_d_3": null
                    }
                },
                "part4": {
                    "notes": [
                        {
                            "requirement": "2"
                        },
                        {
                            "requirement": "3"
                        },
                        {
                            "requirement": "6"
                        },
                        {
                            "requirement": "8"
                        },
                        {
                            "requirement": "9"
                        },
                        {
                            "requirement": "11"
                        },
                        {
                            "requirement": "12"
                        }
                    ]
                }
            },
            "requirements": {
                "requirement2": {
                    "r2_2_2": 1
                },
                "requirement3": {
                    "r3_1_1": 1,
                    "r3_2_1": 1
                },
                "requirement6": {
                    "r6_3_1": 1,
                    "r6_3_3": 1
                },
                "requirement8": {
                    "r8_2_1": 1,
                    "r8_2_2": 1,
                    "r8_2_5": 1,
                    "r8_3_1": 1,
                    "r8_3_5": 1,
                    "r8_3_6": 1,
                    "r8_3_7": 1,
                    "r8_3_9": 1
                },
                "requirement9": {
                    "r9_4_1": 1,
                    "r9_4_1_1": 1,
                    "r9_4_2": 1,
                    "r9_4_3": 1,
                    "r9_4_4": 1,
                    "r9_4_6": 1
                },
                "requirement11": {
                    "r11_3_2": 1,
                    "r11_3_2_1": 1
                },
                "requirement12": {
                    "r12_8_1": 1,
                    "r12_8_2": 1,
                    "r12_8_3": 1,
                    "r12_8_4": 1,
                    "r12_8_5": 1,
                    "r12_10_1": 1
                }
            },
            "appendices": {
                "appendix_b": {
                    "b_0": null,
                    "b_1": null,
                    "b_2": null,
                    "b_3": null,
                    "b_4": null,
                    "b_5": null,
                    "b_6": null
                },
                "appendix_c": {
                    "notes": [
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        },
                        {
                            "label": "",
                            "note": ""
                        }
                    ]
                }
            },
            "extras": {}
        },
        "assessment": {
            "merchant_company_name": null,
            "merchant_dba": null,
            "merchant_company_email": null,
            "merchant_company_website": null,
            "merchant_contact_name": null,
            "merchant_contact_title": null,
            "merchant_contact_email": null,
            "merchant_contact_phone": null,
            "assessor_isa_name": null,
            "assessor_lead_name": null,
            "assessor_company_name": null,
            "assessor_company_website": null,
            "assessor_company_email": null,
            "assessor_email": null,
            "assessor_phone": null,
            "assessor_cert_number": null
        }
    }
}
Modified at 2025-10-31 11:44:15
Previous
List Available SAQ Types
Next
Create a New SAQ
Built with