Telnyx Number Lookup API

openapi: 3.2.0
info:
  title: Telnyx Number Lookup API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Number Lookup across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Number Lookup
  description: Look up phone number data
paths:
  /number_lookup/{phone_number}:
    get:
      summary: Lookup phone number data
      description: Returns information about the provided phone number.
      operationId: LookupNumber
      tags:
      - Number Lookup
      parameters:
      - $ref: '#/components/parameters/PhoneNumber'
      - $ref: '#/components/parameters/NumberLookupType'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                title: Number Lookup Response
                properties:
                  data:
                    $ref: '#/components/schemas/NumberLookupRecord'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        default:
          $ref: '#/components/responses/number-lookup_GenericErrorResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  parameters:
    PhoneNumber:
      name: phone_number
      description: The phone number to be looked up
      in: path
      required: true
      schema:
        type: string
        example: '+18665552368'
    NumberLookupType:
      name: type
      in: query
      required: false
      description: Specifies the type of number lookup to be performed
      schema:
        type: string
        enum:
        - carrier
        - caller-name
    number-lookup_PhoneNumber:
      description: The phone number to be looked up
      in: path
      name: phone_number
      required: true
      schema:
        example: '+18665552368'
        type: string
    NumberLookupType_2:
      name: type
      in: query
      required: false
      description: Specifies the type of number lookup to be performed. May be supplied more than once to request several data sources in a single call (for example, `?type=carrier&type=enhanced-caller-name`). Each requested type populates the corresponding object in the response.
      schema:
        type: string
        enum:
        - carrier
        - caller-name
        - caller-identity
        - enhanced-caller-name
  schemas:
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    Portability:
      type: object
      properties:
        lrn:
          type: string
          description: Local Routing Number, if assigned to the requested phone number
          example: '2245701999'
        ported_status:
          type: string
          description: Indicates whether or not the requested phone number has been ported
          enum:
          - Y
          - N
          - ''
          example: Y
        ported_date:
          type: string
          description: ISO-formatted date when the requested phone number has been ported
          example: '2017-10-20'
        ocn:
          type: string
          description: Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database
          example: 073H
        line_type:
          type: string
          description: Type of number
          example: voip
        spid:
          type: string
          description: SPID (Service Provider ID)
          example: 073H
        spid_carrier_name:
          type: string
          description: Service provider name
          example: Telnyx/4
        spid_carrier_type:
          type: string
          description: Service provider type
          example: '3'
        altspid:
          type: string
          description: Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier
          example: 073H
        altspid_carrier_name:
          type: string
          description: Alternative service provider name
          example: Telnyx/4
        altspid_carrier_type:
          type: string
          description: Alternative service provider type
          example: '3'
        city:
          type: string
          description: City name extracted from the locality in the Local Exchange Routing Guide (LERG) database
          example: WAUKEGAN
        state:
          type: string
          example: Illinois
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    Carrier:
      type: object
      properties:
        mobile_country_code:
          type: string
          description: Region code that matches the specific country calling code if the requested phone number type is mobile
          example: US
        mobile_network_code:
          type: string
          description: National destination code (NDC), with a 0 prefix, if an NDC is found and the requested phone number type is mobile
          example: 0866
        name:
          type: string
          description: SPID (Service Provider ID) name, if the requested phone number has been ported; otherwise, the name of carrier who owns the phone number block
          example: Telnyx/4
        type:
          type: string
          description: A phone number type that identifies the type of service associated with the requested phone number
          enum:
          - fixed line
          - mobile
          - voip
          - fixed line or mobile
          - toll free
          - premium rate
          - shared cost
          - personal number
          - pager
          - uan
          - voicemail
          - unknown
          example: voip
        error_code:
          type:
          - string
          - 'null'
          description: Unused
          example: null
        normalized_carrier:
          type: string
          description: If known to Telnyx and applicable, the primary network carrier.
          example: AT&T
    CallerName:
      type: object
      properties:
        caller_name:
          type: string
          description: The name of the requested phone number's owner as per the CNAM database
          example: TELNYX LLC
        error_code:
          type: string
          description: A caller-name lookup specific error code, expressed as a stringified 5-digit integer
          example: '10001'
    NumberLookupRecord:
      type: object
      title: NumberLookup
      properties:
        record_type:
          type: string
          description: Identifies the type of record
          example: number_lookup
        country_code:
          type: string
          description: Region code that matches the specific country calling code
          example: US
        national_format:
          type: string
          description: Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found
          example: (0312) 945-7420
        phone_number:
          type: string
          description: E164-formatted phone number
          example: '+13129457420'
        fraud:
          type:
          - string
          - 'null'
          description: Unused
          example: null
        carrier:
          $ref: '#/components/schemas/Carrier'
        caller_name:
          $ref: '#/components/schemas/CallerName'
        portability:
          $ref: '#/components/schemas/Portability'
    number-lookup_Error:
      properties:
        code:
          type: string
        detail:
          type: string
        meta:
          additionalProperties: true
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
      type: object
    number-lookup_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/number-lookup_Error'
          type: array
      type: object
    EnhancedCallerName:
      type: object
      description: Enhanced caller name for the phone number's owner. Populated when `type=enhanced-caller-name` is requested.
      properties:
        caller_name:
          type:
          - string
          - 'null'
          description: The name associated with the phone number.
          example: Jane Doe
        error_code:
          type:
          - string
          - 'null'
          description: A lookup-specific error code if the enhanced caller name could not be resolved; otherwise null.
          example: null
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    CallerIdentity:
      type: object
      description: Identity information for the phone number's owner, including name and postal address. Populated when `type=caller-identity` is requested.
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name associated with the phone number.
          example: Jane Doe
        address:
          $ref: '#/components/schemas/number-lookup_Address'
        confidence_score:
          type:
          - number
          - 'null'
          description: 'How strongly the phone number is linked to the returned name, on a scale of 50 to 90 (higher means more supporting signals). Reflects signal strength, not probability: 70 indicates stronger, more consistent evidence than 60, not a 70% chance of being correct. As a guide, 70+ is high confidence, 60 moderate, and 50 limited. Below 50 no name is returned, so scores under 50 are never present.'
          example: 80
        error_code:
          type:
          - string
          - 'null'
          description: A lookup-specific error code if the identity could not be resolved; otherwise null.
          example: null
    Portability_2:
      type: object
      properties:
        lrn:
          type: string
          description: Local Routing Number, if assigned to the requested phone number
          example: '2245701999'
        ported_status:
          type: string
          description: Indicates whether or not the requested phone number has been ported
          enum:
          - Y
          - N
          - ''
          example: Y
        ported_date:
          type: string
          description: ISO-formatted date when the requested phone number has been ported
          example: '2017-10-20'
        ocn:
          type: string
          description: Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database
          example: 073H
        line_type:
          type: string
          description: The line type of the phone number. Uses the same value set as carrier.type; see the API reference for the full list.
          enum:
          - fixed line
          - mobile
          - voip
          - fixed line or mobile
          - toll free
          - premium rate
          - shared cost
          - personal number
          - pager
          - uan
          - voicemail
          - unknown
          example: voip
        spid:
          type: string
          description: SPID (Service Provider ID)
          example: 073H
        spid_carrier_name:
          type: string
          description: Service provider name
          example: Telnyx/4
        spid_carrier_type:
          type: string
          description: Service provider type
          example: '3'
        altspid:
          type: string
          description: Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier
          example: 073H
        altspid_carrier_name:
          type: string
          description: Alternative service provider name
          example: Telnyx/4
        altspid_carrier_type:
          type: string
          description: Alternative service provider type
          example: '3'
        city:
          type: string
          description: City name extracted from the locality in the Local Exchange Routing Guide (LERG) database
          example: WAUKEGAN
        state:
          type: string
          example: Illinois
    number-lookup_Address:
      type: object
      description: Postal address associated with the phone number's owner.
      properties:
        street_line_1:
          type:
          - string
          - 'null'
          description: First line of the street address.
          example: 123 Main St
        street_line_2:
          type:
          - string
          - 'null'
          description: Second line of the street address, if any.
          example: null
        city:
          type:
          - string
          - 'null'
          description: City.
          example: Anytown
        state_code:
          type:
          - string
          - 'null'
          description: Two-letter state or province code.
          example: CA
        postal_code:
          type:
          - string
          - 'null'
          description: Postal or ZIP code.
          example: '90210'
        zip4:
          type:
          - string
          - 'null'
          description: ZIP+4 extension, if available.
          example: '1234'
        country_code:
          type:
          - string
          - 'null'
          description: Two-letter ISO 3166-1 country code.
          example: US
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
    NumberLookupRecord_2:
      type: object
      title: NumberLookup
      properties:
        record_type:
          type: string
          description: Identifies the type of record
          example: number_lookup
        country_code:
          type: string
          description: Region code that matches the specific country calling code
          example: US
        national_format:
          type: string
          description: Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found
          example: (0312) 945-7420
        phone_number:
          type: string
          description: E164-formatted phone number
          example: '+13129457420'
        fraud:
          type:
          - string
          - 'null'
          description: Unused
          example: null
        carrier:
          $ref: '#/components/schemas/Carrier'
        caller_name:
          $ref: '#/components/schemas/CallerName'
        portability:
          $ref: '#/components/schemas/Portability_2'
        nnid_override:
          type:
          - object
          - 'null'
          description: Network number ID (NNID) override for the phone number, when one applies (available only to accounts enabled for NNID); otherwise null.
          properties:
            nnid:
              type: string
              description: The network number ID.
            name:
              type: string
              description: Name associated with the NNID.
            type:
              type: string
              description: The NNID type.
          example: null
        valid_number:
          type: boolean
          description: Indicates whether the phone number is valid.
          example: true
        enhanced_caller_name:
          $ref: '#/components/schemas/EnhancedCallerName'
        caller_identity:
          $ref: '#/components/schemas/CallerIdentity'
  responses:
    number-lookup_GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: '10007'
              title: Unexpected error
              detail: An unexpected error occured.
    UnprocessableEntity:
      description: Unprocessable entity. Check the 'detail' field in response for details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: '10027'
              title: Unprocessable Entity
              detail: The server understood the syntax of the request but was unable to process the instructions.
    NumberLookupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/NumberLookupRecord'
            title: Number Lookup Response
            type: object
      description: Successful response
    number-lookup_UnprocessableEntity:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/number-lookup_Errors'
      description: Unprocessable entity. Check the 'detail' field in response for details.
    number-lookup_GenericErrorResponse_2:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/number-lookup_Errors'
      description: Unexpected error
    number-lookup_UnprocessableEntity_2:
      description: Unprocessable entity. Check the 'detail' field in response for details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors_2'
          example:
            errors:
            - code: '10027'
              title: Unprocessable Entity
              detail: The server understood the syntax of the request but was unable to process the instructions.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt