Cloudmersive Phone Number API

openapi: 3.2.0
info:
  version: v1
  title: validateapi Phone Number API
  description: The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
servers:
- url: http://localhost
tags:
- name: Phone Number
paths:
  /validate/phonenumber/basic:
    post:
      tags:
      - Phone Number
      summary: Validate phone number (basic)
      description: Validate a phone number by analyzing the syntax
      operationId: PhoneNumber_SyntaxOnly
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberValidationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/PhoneNumberValidationResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/PhoneNumberValidationResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumberValidateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/PhoneNumberValidateRequest'
        description: Phone number to validate in a PhoneNumberValidateRequest object.  Try a phone number such as "1.800.463.3339", and either leave DefaultCountryCode blank or use "US".
        required: true
components:
  schemas:
    PhoneNumberValidateRequest:
      description: Request to validate a phone number
      type: object
      properties:
        PhoneNumber:
          description: Raw phone number string to parse as input for validation
          type: string
        DefaultCountryCode:
          description: Optional, default country code.  If left blank, will default to "US".
          type: string
    PhoneNumberValidationResponse:
      description: Result from validating a phone number
      type: object
      properties:
        IsValid:
          description: True if the phone number is valid, false otherwise
          type: boolean
        Successful:
          description: True if the operation was successful, false if there was an error during validation.  See IsValid for validation result.
          type: boolean
        PhoneNumberType:
          description: "Type of phone number; possible values are: FixedLine, Mobile, FixedLineOrMobile, TollFree, PremiumRate, \nSharedCost, Voip, PersonalNumber, Pager, Uan, Voicemail, Unknown"
          type: string
        E164Format:
          description: E.164 format of the phone number
          type: string
        InternationalFormat:
          description: Internaltional format of the phone number
          type: string
        NationalFormat:
          description: National format of the phone number
          type: string
        CountryCode:
          description: Two digit country code of the phone number
          type: string
        CountryName:
          description: User-friendly long name of the country for the phone number
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/validate/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)