> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# phoneNumber

> Phone Number Lookup namespace.

Phone Number Lookup namespace.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/relay/rest/lookup/phone_number/{e164_number}:
    get:
      operationId: subpackagePhoneNumberLookup_lookup_phone_number
      summary: Look up phone number
      description: >-
        Returns validity and formatting information for any supplied E.164 phone
        number, with optional carrier and caller-name data. Use it to normalize
        or enrich a number before other workflows; it neither searches
        purchasable inventory nor returns numbers owned by the project. Use
        [Search phone
        numbers](/docs/apis/rest/phone-numbers/search-available-phone-numbers)
        or [List phone
        numbers](/docs/apis/rest/phone-numbers/list-phone-numbers) for those
        jobs.


        #### Permissions


        No API token scope is required to make a successful request to this
        endpoint.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_phoneNumberLookup
      parameters:
        - name: e164_number
          in: path
          description: The phone number in E.164 format.
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: >-
            Further number information to include in the response, some of which
            are billable. You can specify: carrier (Lookup full carrier
            information for the number), cnam (Lookup Caller ID information for
            the number). Separate multiple values with a comma:
            include=carrier,cnam.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberLookupResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
tags:
  - name: subpackage_phoneNumberLookup
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    CarrierLookupInfo:
      type: object
      properties:
        ocn:
          type: string
          description: The Operating Company Number associated with the number.
        lata:
          type: string
          description: >-
            The Local Access and Transport Area number associated with the
            number.
        city:
          type: string
          description: The City associated with the number.
        state:
          type: string
          description: The State/Province/Region associated with the number.
        jurisdiction:
          type: string
          description: The Jurisdiction associated with the number.
        lec:
          type: string
          description: The LEC or Carrier of the number.
        linetype:
          type: string
          description: >-
            The type of line the number is. Generally either wireless or
            landline.
      description: Carrier lookup information.
      title: CarrierLookupInfo
    CnamInfo:
      type: object
      properties:
        caller_id:
          type: string
          description: The caller ID associated with the number.
      description: Caller ID (CNAM) information.
      title: CnamInfo
    PhoneNumberLookupResponse:
      type: object
      properties:
        country_code_number:
          type: integer
          description: The Country code associated with the number.
        national_number:
          type: string
          description: Number in the countries national format.
        possible_number:
          type: boolean
          description: Whether the number supplied is a possible number.
        valid_number:
          type: boolean
          description: Whether the number supplied is a valid number.
        national_number_formatted:
          type: string
          description: The E164 number formatted in national format.
        international_number_formatted:
          type: string
          description: The E164 number formatted in international format.
        e164:
          type: string
          description: The number in E164 format.
        location:
          type: string
          description: The location of the number based on its area code and NPA.
        country_code:
          type: string
          description: The ISO3166 alpha 2 country code associated with the number.
        timezones:
          type: array
          items:
            type: string
          description: The time zones associated with the number.
        number_type:
          type: string
          description: The type of number based on its area code and NPA.
        carrier:
          $ref: '#/components/schemas/CarrierLookupInfo'
          description: >-
            Carrier information. Adding include=carrier to your request will do
            a live lookup to determine the current carrier information about
            this number.
        cnam:
          $ref: '#/components/schemas/CnamInfo'
          description: >-
            Caller ID information. Adding include=cnam to your request will do a
            live lookup to determine the current caller ID information about
            this number.
      description: Response containing phone number lookup result.
      title: PhoneNumberLookupResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "country_code_number": 1,
  "national_number": "5551234567",
  "possible_number": true,
  "valid_number": true,
  "national_number_formatted": "(555) 123-4567",
  "international_number_formatted": "+1 555-123-4567",
  "e164": "+15551234567",
  "location": "Texas",
  "country_code": "US",
  "timezones": [
    "string"
  ],
  "number_type": "Fixed Line or Mobile",
  "carrier": {
    "ocn": "12345",
    "lata": "99999",
    "city": "Aberdeen",
    "state": "WA",
    "jurisdiction": "indeterminate",
    "lec": "Verizon",
    "linetype": "landline"
  },
  "cnam": {
    "caller_id": "John Smith"
  }
}
```

## **Example**

```typescript {4}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient();
const result = await client.lookup.phoneNumber("+15551234567");
console.log(result);
```

> Phone Number Lookup namespace.