CG Scanning API V2
5.2.0
  • latest
  • 5.2.0
  • 5.3.0
HomeDocs
HomeDocs
5.2.0
  • latest
  • 5.2.0
  • 5.3.0
  1. User 2FA
  • Scanning API
    • Common Error Responses
    • Authentication
    • Filtering Data
    • Getting Started
    • 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
    • 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
    • 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
    • Hosts
      • List of hosts
      • Host details
      • List of most vulnerable hosts
    • 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
    • Whitelabel Settings
      • Show the white label settings
      • Show the white label settings
      • Update white label settings
    • 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
    • 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
    • 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
    • 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
    • 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
    • Targets
      • List targets
      • Create Target
      • Show a target
      • Updates a target
      • Delete a target
      • Delete targets
    • User
      • User 2FA
        • Enable 2FA
          PUT
        • Verify 2FA installation
          PUT
        • Disable 2FA
          PUT
        • Lookup phone number
          GET
        • Default 2FA method
          PUT
        • Generate Recovery Codes
          PUT
        • Get Recovery Codes
          GET
      • User Preferences
        • Get users notification preferences
        • Change users product
        • Enable user's event notification preference
        • Disable user's event notification preference
      • Get current user
        GET
      • Update current user
        PUT
      • Change current user password
        PUT
      • Get current user active plans (Not implemented yet)
        GET
      • Get organization members
        GET
      • Get current user products
        GET
      • Get current organization
        GET
      • Update current organization
        PUT
      • Get subscriptions history
        GET
      • Change users product
        PUT
      • Checks if authorization token is valid
        GET
      • Get current user permissions
        GET
      • Check if the user can be deleted
        GET
      • Delete my account
        DELETE
      • Generates a new access token
        PUT
      • Revokes the current access token
        PUT
      • (Admin) Transfers all the resources from the user to another user
        PUT
    • 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
    • Vulnerabilities
      • List of vulnerabilities
      • Vulnerability details
      • Total Vulnerabilities (widget)
      • Top Vulnerabilities (widget)
      • PCI Compliant (widget)
      • (AI) Send prompt about a given Vulnerability
      • (AI) Chat history about a given Vulnerability
    • 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
  1. User 2FA

Verify 2FA installation

PUT
/v2/user/mfa/verify_installation
Last modified:2025-04-24 10:59:46
This endpoint is integral to the Two-Factor Authentication (2FA) setup process.
Once the user initiates 2FA enablement and receives a verification code (via SMS OTP or TOTP),
this endpoint serves to validate the successful installation of the chosen 2FA method.
Users must submit the received code to confirm and complete the 2FA activation process.
Successful verification ensures a secure and accurate integration of 2FA for enhanced account security.

Request

Query Params

Responses

🟢200OK
application/json
2FA verified
Body

🟠401Unauthorized
🟠422Parameter Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v2/user/mfa/verify_installation?method&otp_attempt'
Response Response Example
200 - sms_success
{
    "status": "verified"
}
Modified at 2025-04-24 10:59:46
Previous
Enable 2FA
Next
Disable 2FA
Built with