Lookup a phone number

Overview

This API allows for the lookup of a phone number. The response consists of the 'carrier' information, 'countryCode', 'phoneNumber.endpoint' and the phone number in the 'nationalFormat'.

For this API to execute succesfully, the phone number

  • Must be a valid United States phone number

Scope

Client app must have 'app.core.microservicesmgr.lookup.read' scope assigned.

SecurityoAuthClient
Request
path Parameters
phoneNumber
required
string [ 1 .. 24 ]

phone number

Example: +18135556666
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/phones/{phoneNumber}
Request samples
Response samples
application/json
{
  • "carrier": {
    },
  • "phoneNumber": {
    },
  • "countryCode": "US",
  • "nationalFormat": "(813) 555-6666"
}