Retrieve Phone Details | Pinnacle

1 import { PinnacleClient } from "rcs-js"; 2 3 async function main() { 4 const client = new PinnacleClient({ 5 environment: "https://api.pinnacle.sh", 6 }); 7 await client.phoneNumbers.get({ 8 phone: "+11234567890", 9 level: "advanced", 10 options: { 11 risk: true, 12 enhancedContactInfo: { 13 context: "This is my friend from JZ. He has done a lot in the crypto space.", 14 }, 15 }, 16 }); 17 } 18 main();

1 { 2 "isValid": true, 3 "type": "MOBILE", 4 "formats": { 5 "international": "+11234567890", 6 "national": "(123) 456-7890", 7 "raw": "12345678901" 8 }, 9 "location": { 10 "country": { 11 "code": "US", 12 "name": "United States", 13 "prefix": "+1" 14 }, 15 "place": "Springfield, Illinois" 16 }, 17 "carrier": "Example Telecom", 18 "contact": { 19 "name": "DOE, JOHN" 20 } 21 }

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.

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

Advanced Lookupobject

Authentication

Request

Response

Errors