Skip to main content

Report a Phone Number

POST 

/v1/users/{userId}/report

Reports a phone number as spam, scam, or unwanted, contributing to Hiya's global caller reputation database.

Report Categories​

Users can report numbers for:

  • Spam: Unsolicited marketing or robocalls
  • Scam: Fraudulent calls attempting to deceive the user

Impact​

Reports are aggregated across all users to:

  • Update the number's reputation score in Hiya's database
  • Improve spam/scam detection for all platform users
  • Inform carrier-level blocking decisions

Privacy​

The reporter's identity is not shared with the reported number. Reports are anonymized for aggregate analysis.

Path Parameters​


    userId stringrequired

    UUID for the given user

Header Parameters​


    x-hiya-product-version string

    Product version. The standard "major.minor.patch" format is highly encouraged without any leading characters; "2.1.3" or "3.0.0" for example.


    x-hiya-account-user-id stringrequired

    The identifier of a logged-in user. Same identifier that is used for /users/{user_id}

Body

required

application/json

Responses​

OK