Cloudmersive Name API

openapi: 3.2.0
info:
  version: v1
  title: validateapi Name 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: Name
paths:
  /validate/name/full-name:
    post:
      tags:
      - Name
      summary: Parse and validate a full name
      description: Parses a full name string (e.g. "Mr. Jon van der Waal Jr.") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not
      operationId: Name_ValidateFullName
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullNameValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FullNameValidationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/FullNameValidationResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/FullNameValidationResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FullNameValidationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FullNameValidationRequest'
        description: Validation request information
        required: true
  /validate/name/first:
    post:
      tags:
      - Name
      summary: Validate a first name
      description: Determines if a string is a valid first name (given name)
      operationId: Name_ValidateFirstName
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirstNameValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FirstNameValidationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/FirstNameValidationResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/FirstNameValidationResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FirstNameValidationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FirstNameValidationRequest'
        description: Validation request information
        required: true
  /validate/name/last:
    post:
      tags:
      - Name
      summary: Validate a last name
      description: Determines if a string is a valid last name (surname)
      operationId: Name_ValidateLastName
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LastNameValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/LastNameValidationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/LastNameValidationResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/LastNameValidationResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LastNameValidationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/LastNameValidationRequest'
        description: Validation request information
        required: true
  /validate/name/get-gender:
    post:
      tags:
      - Name
      summary: Get the gender of a first name
      description: Determines the gender of a first name (given name)
      operationId: Name_GetGender
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGenderResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetGenderResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetGenderResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/GetGenderResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetGenderRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/GetGenderRequest'
        description: Gender request information
        required: true
  /validate/name/identifier:
    post:
      tags:
      - Name
      summary: Validate a code identifier
      description: Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be "helloWorld" but not "hello*World".
      operationId: Name_Identifier
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateIdentifierResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidateIdentifierResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ValidateIdentifierResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/ValidateIdentifierResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateIdentifierRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ValidateIdentifierRequest'
        description: Identifier validation request information
        required: true
components:
  schemas:
    GetGenderRequest:
      description: Request to get the gender from a first name
      type: object
      properties:
        FirstName:
          description: Input first name (given name) to get the gender of
          type: string
        CountryCode:
          description: Optional; the country for this name, possible values are "US", "LY", "NI", "TT", "MK", "KZ", "BO", "UG", "TZ", "CL", "SI", "MA", "RW", "VN", "AW", "CY", "BH", "SG", "ZA", "MU", "BR", "TN", "KH", "US", "TH", "TW", "UY", "DO", "CO", "UA", "QA", "BY", "SN", "SD", "FJ", "LB", "BE", "ML", "LV", "FR", "TM", "NG", "EC", "NO", "SL", "CR", "PA", "GE", "CH", "KR", "RS", "ZM", "FI", "BF", "MC", "AU", "GA", "LS", "RU", "IN", "SE", "LK", "BZ", "MX", "GH", "AF", "TJ", "BN", "DZ", "CM", "GR", "MD", "HN", "AT", "NZ", "SV", "GW", "NA", "AR", "MZ", "PK", "MN", "IQ", "BW", "VE", "PT", "BS", "AL", "TG", "ID", "ET", "CF", "JP", "BB", "PH", "CU", "BD", "AO", "SM", "LC", "ME", "RO",  DANIL"O"", "ES", "EE", "IL", "ZW", "SY", "MW", "LU", "IR", "SC", "NL", "JO", "AM", "DE", "GL", "OM", "DK", "HR", "LI", "TD", "KM", "BA", "GM", "GD", "CA", "CZ", "MR", "ST", "IS", "LR", "IE", "VC", "AE", "KG", "DJ", "TR", "KE", "NE", "UZ", "CN", "GQ", "SK", "BJ", "MG", "BT", "EG", "PL", "IT", "SA", "MY", "CI", "AG", "AD", "KS", "HU", "CG", "KP", "DM", "GN", "GT", "NP", "JM", "LA", "GB", "BG", "HT", "PE", "AZ", "LT", "SZ", "PY", "MT", "VA"
          type: string
    ValidateIdentifierRequest:
      description: Identifier validation request, including the input identifier as well as various identifier rules
      type: object
      properties:
        Input:
          description: Text string identifier input
          type: string
        AllowWhitespace:
          description: True if whitespace is allowed in the identifier, false otherwise
          type: boolean
        AllowHyphens:
          description: True if hyphens are allowd in the identifier, false otherwise
          type: boolean
        AllowUnderscore:
          description: True if underscores are allowed in the identifier, false otherwise
          type: boolean
        AllowNumbers:
          description: True if numbers are allowed in the identifier, false otherwise
          type: boolean
        AllowPeriods:
          description: True if periods are allowed in the identifier, false otherwise
          type: boolean
        MaxLength:
          format: int32
          description: Optional; maximum length, if any, of the identifier
          type: integer
        MinLength:
          format: int32
          description: Optional; minimum length, if any, of the identifier
          type: integer
    FullNameValidationResponse:
      description: Result of a full name validation operation
      type: object
      properties:
        Successful:
          description: True if the validation operation was successful, false otherwise
          type: boolean
        ValidationResult_FirstName:
          description: 'Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty'
          type: string
        ValidationResult_LastName:
          description: 'Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty'
          type: string
        Title:
          description: The person's title (if supplied), e.g. "Mr." or "Ms."
          type: string
        FirstName:
          description: The first name (given name)
          type: string
        MiddleName:
          description: The middle name(s); if there are multiple names they will be separated by spaces
          type: string
        LastName:
          description: The last name (surname)
          type: string
        NickName:
          description: Nickname (if supplied)
          type: string
        Suffix:
          description: Suffix to the name, e.g. "Jr." or "Sr."
          type: string
        DisplayName:
          description: The full display name of the name
          type: string
    FirstNameValidationRequest:
      description: Request to validate a first name
      type: object
      properties:
        FirstName:
          description: First name to process
          type: string
    LastNameValidationRequest:
      description: Request to validate a last name
      type: object
      properties:
        LastName:
          description: Last name to process
          type: string
    ValidateIdentifierResponse:
      description: Result of performing an identifier validation operation
      type: object
      properties:
        ValidIdentifier:
          description: True if the input identifier is valid, false otherwise
          type: boolean
        Error:
          description: 'Resulting error from the identifier validation; possible errors are: "InputIsEmpty", "ContainsWhitespace", "ContainsNumbers", "ContainsHyphen", "ContainsUnderscore", "ContainsPeriod", "TooShort", "TooLong", "ContainsSpecialCharacters"'
          type: string
    LastNameValidationResponse:
      description: Result of a last name validation operation
      type: object
      properties:
        Successful:
          description: True if the validation operation was successful, false otherwise
          type: boolean
        ValidationResult:
          description: 'Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty'
          type: string
    FirstNameValidationResponse:
      description: Result of a first name validation operation
      type: object
      properties:
        Successful:
          description: True if the validation operation was successful, false otherwise
          type: boolean
        ValidationResult:
          description: 'Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty'
          type: string
    FullNameValidationRequest:
      description: Request to validate a full name string
      type: object
      properties:
        FullNameString:
          description: Full name to process as a free-form string; supports many components such as First Name, Middle Name, Last Name, Title, Nickname, Suffix, and Display Name
          type: string
    GetGenderResponse:
      description: Result of the GetGender operation
      type: object
      properties:
        Successful:
          description: True if successful, false otherwise
          type: boolean
        Gender:
          description: Gender for this name; possible values are Male, Female, and Neutral (can be applied to Male or Female)
          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)