Lookup Phone Number Profile
GET/v1/phones/phoneProfile
Retrieves reputation and identity information for a phone number from Hiya's global intelligence database.
Response Data
The profile includes:
- Caller Identity: Name, business type, and verified status (if available)
- Reputation Score: Risk assessment based on community reports and network analysis
- Category Classification: Spam, scam, fraud, robocall, telemarketer, or legitimate
Use Cases
- Call Log Enhancement: Enrich call history with caller details
- Contact Verification: Validate unknown numbers from the address book
Query Parameters
phone stringrequired
The phone number to lookup (does not need to be in E.164 - send it as you have it)
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}
Responses
- 200
- 400
- 404
- 500
OK
Response Body
Bad Request
Response Body
Not Found
Response Body
Internal Server Error
Response Body