API ReferencePhone Numbers

Number Intelligence - Get Phone Details

Retrieve information about any phone number.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
phonestringRequired
Phone number you want to analyze in E.164 format.
levelenumRequired

Choose how much detail you want in your results:

  • basic: Receive essential info like carrier, location, and format.
  • advanced: Receive a deeper analysis including fraud risk, detailed location, and enhanced contact info.
Allowed values:
optionsobjectOptional
Customize your lookup with additional options.

Response

Returns detailed information for the requested phone number based on the selected lookup.
Basic Lookupobject
Key details about a phone number, including its validity, type, location, carrier, and contact information. Provides the essential data required for verification, display, and basic analysis.
OR
Advanced Lookupobject
Detailed phone number analysis including validation status, classification with fraud risk, precise geographic data, carrier intelligence, and enhanced contact information. Provides comprehensive insights for risk assessment, compliance, and advanced usage scenarios.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error