Skip to content

Submit URL for verification

View .md
POST

Submit a URL for verification. URLs are automatically checked against Google Web Risk API. Safe URLs are auto-approved, malicious URLs are blocked. URL shorteners (bit.ly, t.co, etc.) are always blocked.

Important: SMS, one-way SMS and voice messages containing URLs require those URLs to be verified before the message can be sent; a URL that is not yet known is checked when the message is sent. Email, WhatsApp, Telegram, Instagram and Messenger messages are not checked. This endpoint allows pre-verification of URLs.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Body

application/json

  • urlstringrequired

    The URL to submit for verification.

Responses

200URL already verified.
  • urlobjectrequired
    7 properties
    • idstringrequired
    • urlstringrequired

      The verified URL.

    • domainstringrequired

      Domain extracted from the URL.

    • statusstringrequired

      Status of a verified URL.

      One ofpendingapprovedrejectedescalatedmalicious
    • approvalTypestring

      How the URL was approved or rejected.

      One ofmanualauto_web_risk
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>
201URL verified and approved.
  • urlobjectrequired
    7 properties
    • idstringrequired
    • urlstringrequired

      The verified URL.

    • domainstringrequired

      Domain extracted from the URL.

    • statusstringrequired

      Status of a verified URL.

      One ofpendingapprovedrejectedescalatedmalicious
    • approvalTypestring

      How the URL was approved or rejected.

      One ofmanualauto_web_risk
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>
400Invalid request.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
403URL blocked (malicious, rejected, or shortener).
  • codestringrequired
  • messagestringrequired
  • detailsobject