> ## Documentation Index
> Fetch the complete documentation index at: https://docs.baselayer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Web Presence Request

> Retrieve a Web Presence Request.



## OpenAPI

````yaml /api-reference/openapi.json get /web_presence_requests/{id}
openapi: 3.1.0
info:
  title: baselayer-api-service
  version: 0.1.0
servers:
  - url: https://api.baselayer.com/
security: []
paths:
  /web_presence_requests/{id}:
    get:
      tags:
        - Web Presence
      summary: Get Web Presence Request
      description: Retrieve a Web Presence Request.
      operationId: get_web_presence_request_web_presence_requests__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Web Presence Request ID
            description: The unique identifier of the Web Presence request.
          description: The unique identifier of the Web Presence request.
      responses:
        '200':
          description: Web Presence Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1.WebPresenceResponse'
            application/vnd.baselayer.v1+json:
              schema:
                $ref: '#/components/schemas/v1.WebPresenceResponse'
            application/vnd.baselayer.v2+json:
              schema:
                $ref: '#/components/schemas/v2.WebPresenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    v1.WebPresenceResponse:
      description: >-
        Web presence response - either US or International based on the
        request's country code.


        This is a discriminated union that selects the appropriate response type

        based on the `request_type` field.
      discriminator:
        mapping:
          INTERNATIONAL:
            $ref: '#/components/schemas/v1.InternationalWebPresenceResponse'
          UNITED_STATES:
            $ref: '#/components/schemas/v1.USWebPresenceResponse'
        propertyName: request_type
      oneOf:
        - $ref: '#/components/schemas/v1.USWebPresenceResponse'
        - $ref: '#/components/schemas/v1.InternationalWebPresenceResponse'
      title: WebPresenceResponse
    v2.WebPresenceResponse:
      description: >-
        Web presence response - either US or International based on the
        request's country code.


        This is a discriminated union that selects the appropriate response type

        based on the `request_type` field.
      discriminator:
        mapping:
          INTERNATIONAL:
            $ref: '#/components/schemas/v1.InternationalWebPresenceResponse'
          UNITED_STATES:
            $ref: '#/components/schemas/v1.USWebPresenceResponse'
        propertyName: request_type
      oneOf:
        - $ref: '#/components/schemas/v1.USWebPresenceResponse'
        - $ref: '#/components/schemas/v1.InternationalWebPresenceResponse'
      title: WebPresenceResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    v1.InternationalWebPresenceResponse:
      properties:
        request_type:
          const: INTERNATIONAL
          description: The type of web presence request.
          examples:
            - INTERNATIONAL
          title: Request Type
          type: string
        id:
          description: The ID of the Web Presence request
          examples:
            - 46c0e847-a0c1-43f9-9b36-8ea7a0e17319
          format: uuid
          title: Id
          type: string
        state:
          $ref: '#/components/schemas/v1.TaskState'
          description: The status of the Web Presence request
          examples:
            - COMPLETED
        created_at:
          description: The date and time when the Web Presence request was created.
          examples:
            - '2026-08-31T10:31:07.808516'
          format: date-time
          title: Created At
          type: string
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          default: null
          description: >-
            The most recent date and time when the Web Presence request was
            updated.
          examples:
            - '2026-08-31T10:31:07.808526'
          title: Updated At
        options:
          description: The options for the web presence request.
          examples:
            - - Order.NaicsPrediction
              - Order.WebsiteAnalysis
          items:
            enum:
              - Order.SocialMedia
              - Order.ReviewSummary
              - Order.ReviewFull
              - Order.NaicsPrediction
              - Order.WebsiteAnalysis
              - Order.DirectoryListing
            title: WebPresenceRequestOptions
            type: string
          title: Options
          type: array
        name:
          description: The name of the business as it was input for the search.
          examples:
            - Ray's Pizza
          title: Name
          type: string
        alternative_names:
          anyOf:
            - items:
                type: string
              maxItems: 10
              type: array
            - type: 'null'
          description: Alternative names for the business (e.g., DBA names)
          examples:
            - Orginal Ray's Pizza
            - Ray's Famous Pizza
          title: Alternative Names
        address:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          default: null
          description: The address of the business as it was input for the search.
          examples:
            - 123 Main St, Anytown, USA
          title: Address
        iso2_country_code:
          anyOf:
            - $ref: '#/components/schemas/v1.ISO2CountryCode'
            - type: 'null'
          default: null
          description: >-
            The ISO 2 country code of the business as it was input for the
            search.
          examples:
            - US
        website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The website of the business as it was input for the search.
          examples:
            - https://www.actual-valid-company-website.com/
          title: Website
        officer_names:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: >-
            A list of business officers related to the business as they were
            input for the search.
          examples:
            - - John Doe
              - Jane Smith
          title: Officer Names
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The phone number as it was input for the search.
          examples:
            - 123-456-7890
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The email as it was input for the search.
          examples:
            - support@example.com
          title: Email
        reference_id:
          anyOf:
            - maxLength: 128
              type: string
            - type: 'null'
          default: null
          description: An optional reference ID associated with the web presence request.
          examples:
            - WebPresence1234
          title: Reference Id
        business_address_match:
          anyOf:
            - $ref: '#/components/schemas/v1.InternationalAddressMatchType'
            - type: 'null'
          default: null
          description: >-
            Indicates how closely the inputted address matches the found
            business entity.
          examples:
            - EXACT
            - REGION
            - NO_MATCH
        business_address_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: >-
            The sources where the best address match was found. Only populated
            when business_address_match is not NoMatch.
          examples:
            - - FOUND_WEBSITE
              - REVIEW
            - - INPUT_WEBSITE
              - DIRECTORY
          title: Business Address Match Sources
        phone_number_match:
          anyOf:
            - $ref: '#/components/schemas/v1.PhoneNumberMatchType'
            - type: 'null'
          default: null
          description: >-
            Indicates how closely the inputted phone number matches phone
            numbers found during discovery. Only populated when a phone number
            was provided in the request.
          examples:
            - EXACT
            - AREA_CODE
            - NO_MATCH
        phone_number_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: >-
            The sources where the best phone number match was found. Only
            populated when phone_number_match is not NoMatch.
          examples:
            - - FOUND_WEBSITE
              - SOCIAL_PROFILE
            - - REVIEW
              - DIRECTORY
          title: Phone Number Match Sources
        email_match:
          anyOf:
            - $ref: '#/components/schemas/v1.EmailMatchType'
            - type: 'null'
          default: null
          description: >-
            Indicates how closely the inputted email matches emails found during
            discovery. Only populated when an email was provided in the request.
          examples:
            - EXACT
            - DOMAIN
            - NO_MATCH
        email_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: >-
            The sources where the best email match was found. Only populated
            when email_match is not NoMatch.
          examples:
            - - FOUND_WEBSITE
              - SOCIAL_PROFILE
            - - INPUT_WEBSITE
              - DIRECTORY
          title: Email Match Sources
        people_match:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            True if at least one officer name matches a person discovered during
            web presence analysis (exact or similar). Only populated when
            officer_names were provided in the request.
          examples:
            - true
            - false
          title: People Match
        people_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: The sources where the people match was found.
          examples:
            - - FOUND_WEBSITE
              - DIRECTORY
            - - DIRECTORY
          title: People Match Sources
        business_website_match:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Indicates whether the inputted website matches the found business
            entity.
          examples:
            - true
            - false
          title: Business Website Match
        business_website_redirect_match:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Indicates whether the website match was established via a
            cross-domain redirect. True when business_website_match is True and
            the match was found because one website redirects to the other's
            domain.
          examples:
            - true
            - false
          title: Business Website Redirect Match
        found_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The discovered website of the business.
          examples:
            - https://example.com/
          title: Found Website
        website_accuracy:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          deprecated: true
          description: The confidence score of the discovered website.
          examples:
            - 0.95
          title: Website Accuracy
        found_social_profiles:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredSocialProfile'
              type: array
            - type: 'null'
          default: null
          description: A list of discovered social profiles related to the business.
          title: Found Social Profiles
        input_social_profiles:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredSocialProfile'
              type: array
            - type: 'null'
          default: null
          description: Scraped social profiles from user-provided inputs.
          title: Input Social Profiles
        social_profiles_match:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.InputSocialProfileMatch'
              type: array
            - type: 'null'
          default: null
          description: >-
            Match results for user-provided social profile inputs. Each entry
            echoes back the original input (site, value) and indicates whether
            it was also independently found during organic social discovery.
          title: Social Profiles Match
        found_reviews:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredReview'
              type: array
            - type: 'null'
          default: null
          description: A list of discovered reviews related to the business.
          title: Found Reviews
        found_directory_listings:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredDirectoryListing'
              type: array
            - type: 'null'
          default: null
          description: A list of discovered directory listings related to the business.
          title: Found Directory Listings
        website_analysis:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteAnalysisDetails'
            - type: 'null'
          default: null
          description: The website analysis details associated with the web presence.
          examples:
            - addresses: []
              console_url: https://console.baselayer.com/website_analysis/uuid
              email_deliverable: null
              emails:
                - contact@example.com
              id: 7d8311fe-956e-4524-8152-6a4a3691f64f
              parked: false
              people: []
              phone_numbers:
                - 123-456-7890
              redirects: null
              screenshot_url: https://api.baselayer.com/website_analysis/uuid/screenshot
              social_profiles: []
              ssl_validity: null
              url: http://example.com/
              website_build_status: null
              website_structure_metrics: null
              website_summary: null
              whois_record: null
        input_website_analysis:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteAnalysisDetails'
            - type: 'null'
          default: null
          description: The website analysis details associated with the input website.
          examples:
            - addresses: []
              console_url: https://console.baselayer.com/website_analysis/uuid
              email_deliverable: null
              emails:
                - contact@example.com
              id: 39a3259a-d973-46f1-b15f-47cfae7fcf43
              parked: false
              people: []
              phone_numbers:
                - 123-456-7890
              redirects: null
              screenshot_url: https://api.baselayer.com/website_analysis/uuid/screenshot
              social_profiles: []
              ssl_validity: null
              url: http://example.com/
              website_build_status: null
              website_structure_metrics: null
              website_summary: null
              whois_record: null
        industry_prediction:
          anyOf:
            - $ref: '#/components/schemas/v1.PredictedNaicsResponse'
            - type: 'null'
          default: null
          description: The predicted NAICS code associated with the web presence.
          examples:
            - accuracy: 0.95
              code: '541330'
              keywords:
                - Engineering
                - Services
              mcc_codes:
                - code: '1234'
                  description: null
                  mastercard_risk: null
                  visa_risk_tier: null
              reasoning: null
              risk_level: low
              sic_codes:
                - code: '5678'
                  description: null
              title: Engineering Services
        scores:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.ScoreResponse'
              type: array
            - type: 'null'
          default: null
          description: >-
            The scores associated with the web presence request, including
            WebKYB and WebRisk scores.
          title: Scores
      required:
        - request_type
        - id
        - state
        - created_at
        - name
      title: InternationalWebPresenceResponse (v1)
      type: object
    v1.USWebPresenceResponse:
      properties:
        request_type:
          const: UNITED_STATES
          description: The type of web presence request.
          examples:
            - UNITED_STATES
          title: Request Type
          type: string
        id:
          description: The ID of the Web Presence request
          examples:
            - fcc61370-fddf-4f53-b3bc-084f0367a025
          format: uuid
          title: Id
          type: string
        state:
          $ref: '#/components/schemas/v1.TaskState'
          description: The status of the Web Presence request
          examples:
            - COMPLETED
        created_at:
          description: The date and time when the Web Presence request was created.
          examples:
            - '2026-08-31T10:31:07.806450'
          format: date-time
          title: Created At
          type: string
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          default: null
          description: >-
            The most recent date and time when the Web Presence request was
            updated.
          examples:
            - '2026-08-31T10:31:07.806461'
          title: Updated At
        options:
          description: The options for the web presence request.
          examples:
            - - Order.NaicsPrediction
              - Order.WebsiteAnalysis
          items:
            enum:
              - Order.SocialMedia
              - Order.ReviewSummary
              - Order.ReviewFull
              - Order.NaicsPrediction
              - Order.WebsiteAnalysis
              - Order.DirectoryListing
            title: WebPresenceRequestOptions
            type: string
          title: Options
          type: array
        name:
          description: The name of the business as it was input for the search.
          examples:
            - Ray's Pizza
          title: Name
          type: string
        alternative_names:
          anyOf:
            - items:
                type: string
              maxItems: 10
              type: array
            - type: 'null'
          description: Alternative names for the business (e.g., DBA names)
          examples:
            - Orginal Ray's Pizza
            - Ray's Famous Pizza
          title: Alternative Names
        address:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          default: null
          description: The address of the business as it was input for the search.
          examples:
            - 123 Main St, Anytown, USA
          title: Address
        iso2_country_code:
          anyOf:
            - $ref: '#/components/schemas/v1.ISO2CountryCode'
            - type: 'null'
          default: null
          description: >-
            The ISO 2 country code of the business as it was input for the
            search.
          examples:
            - US
        website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The website of the business as it was input for the search.
          examples:
            - https://www.actual-valid-company-website.com/
          title: Website
        officer_names:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: >-
            A list of business officers related to the business as they were
            input for the search.
          examples:
            - - John Doe
              - Jane Smith
          title: Officer Names
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The phone number as it was input for the search.
          examples:
            - 123-456-7890
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The email as it was input for the search.
          examples:
            - support@example.com
          title: Email
        reference_id:
          anyOf:
            - maxLength: 128
              type: string
            - type: 'null'
          default: null
          description: An optional reference ID associated with the web presence request.
          examples:
            - WebPresence1234
          title: Reference Id
        business_address_match:
          anyOf:
            - $ref: '#/components/schemas/v1.AddressMatchType'
            - type: 'null'
          default: null
          description: >-
            Indicates how closely the inputted address matches the found
            business entity.
          examples:
            - EXACT
            - CITY
            - NO_MATCH
        business_address_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: >-
            The sources where the best address match was found. Only populated
            when business_address_match is not NoMatch.
          examples:
            - - FOUND_WEBSITE
              - REVIEW
            - - INPUT_WEBSITE
              - DIRECTORY
          title: Business Address Match Sources
        phone_number_match:
          anyOf:
            - $ref: '#/components/schemas/v1.PhoneNumberMatchType'
            - type: 'null'
          default: null
          description: >-
            Indicates how closely the inputted phone number matches phone
            numbers found during discovery. Only populated when a phone number
            was provided in the request.
          examples:
            - EXACT
            - AREA_CODE
            - NO_MATCH
        phone_number_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: >-
            The sources where the best phone number match was found. Only
            populated when phone_number_match is not NoMatch.
          examples:
            - - FOUND_WEBSITE
              - SOCIAL_PROFILE
            - - REVIEW
              - DIRECTORY
          title: Phone Number Match Sources
        email_match:
          anyOf:
            - $ref: '#/components/schemas/v1.EmailMatchType'
            - type: 'null'
          default: null
          description: >-
            Indicates how closely the inputted email matches emails found during
            discovery. Only populated when an email was provided in the request.
          examples:
            - EXACT
            - DOMAIN
            - NO_MATCH
        email_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: >-
            The sources where the best email match was found. Only populated
            when email_match is not NoMatch.
          examples:
            - - FOUND_WEBSITE
              - SOCIAL_PROFILE
            - - INPUT_WEBSITE
              - DIRECTORY
          title: Email Match Sources
        people_match:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            True if at least one officer name matches a person discovered during
            web presence analysis (exact or similar). Only populated when
            officer_names were provided in the request.
          examples:
            - true
            - false
          title: People Match
        people_match_sources:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebPresenceSource'
              type: array
            - type: 'null'
          default: null
          description: The sources where the people match was found.
          examples:
            - - FOUND_WEBSITE
              - DIRECTORY
            - - DIRECTORY
          title: People Match Sources
        business_website_match:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Indicates whether the inputted website matches the found business
            entity.
          examples:
            - true
            - false
          title: Business Website Match
        business_website_redirect_match:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Indicates whether the website match was established via a
            cross-domain redirect. True when business_website_match is True and
            the match was found because one website redirects to the other's
            domain.
          examples:
            - true
            - false
          title: Business Website Redirect Match
        found_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: The discovered website of the business.
          examples:
            - https://example.com/
          title: Found Website
        website_accuracy:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          deprecated: true
          description: The confidence score of the discovered website.
          examples:
            - 0.95
          title: Website Accuracy
        found_social_profiles:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredSocialProfile'
              type: array
            - type: 'null'
          default: null
          description: A list of discovered social profiles related to the business.
          title: Found Social Profiles
        input_social_profiles:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredSocialProfile'
              type: array
            - type: 'null'
          default: null
          description: Scraped social profiles from user-provided inputs.
          title: Input Social Profiles
        social_profiles_match:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.InputSocialProfileMatch'
              type: array
            - type: 'null'
          default: null
          description: >-
            Match results for user-provided social profile inputs. Each entry
            echoes back the original input (site, value) and indicates whether
            it was also independently found during organic social discovery.
          title: Social Profiles Match
        found_reviews:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredReview'
              type: array
            - type: 'null'
          default: null
          description: A list of discovered reviews related to the business.
          title: Found Reviews
        found_directory_listings:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.DiscoveredDirectoryListing'
              type: array
            - type: 'null'
          default: null
          description: A list of discovered directory listings related to the business.
          title: Found Directory Listings
        website_analysis:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteAnalysisDetails'
            - type: 'null'
          default: null
          description: The website analysis details associated with the web presence.
          examples:
            - addresses: []
              console_url: https://console.baselayer.com/website_analysis/uuid
              email_deliverable: null
              emails:
                - contact@example.com
              id: 440d3f9b-b486-4dfc-855e-48a886fb421b
              parked: false
              people: []
              phone_numbers:
                - 123-456-7890
              redirects: null
              screenshot_url: https://api.baselayer.com/website_analysis/uuid/screenshot
              social_profiles: []
              ssl_validity: null
              url: http://example.com/
              website_build_status: null
              website_structure_metrics: null
              website_summary: null
              whois_record: null
        input_website_analysis:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteAnalysisDetails'
            - type: 'null'
          default: null
          description: The website analysis details associated with the input website.
          examples:
            - addresses: []
              console_url: https://console.baselayer.com/website_analysis/uuid
              email_deliverable: null
              emails:
                - contact@example.com
              id: 6d0cc9e4-a569-4784-afa3-112e6f6d5f72
              parked: false
              people: []
              phone_numbers:
                - 123-456-7890
              redirects: null
              screenshot_url: https://api.baselayer.com/website_analysis/uuid/screenshot
              social_profiles: []
              ssl_validity: null
              url: http://example.com/
              website_build_status: null
              website_structure_metrics: null
              website_summary: null
              whois_record: null
        industry_prediction:
          anyOf:
            - $ref: '#/components/schemas/v1.PredictedNaicsResponse'
            - type: 'null'
          default: null
          description: The predicted NAICS code associated with the web presence.
          examples:
            - accuracy: 0.95
              code: '541330'
              keywords:
                - Engineering
                - Services
              mcc_codes:
                - code: '1234'
                  description: null
                  mastercard_risk: null
                  visa_risk_tier: null
              reasoning: null
              risk_level: low
              sic_codes:
                - code: '5678'
                  description: null
              title: Engineering Services
        scores:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.ScoreResponse'
              type: array
            - type: 'null'
          default: null
          description: >-
            The scores associated with the web presence request, including
            WebKYB and WebRisk scores.
          title: Scores
      required:
        - request_type
        - id
        - state
        - created_at
        - name
      title: USWebPresenceResponse (v1)
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    v1.TaskState:
      enum:
        - PENDING
        - EXECUTING
        - COMPLETED
        - FAILED
        - CANCELLED
      title: TaskState
      type: string
    v1.ISO2CountryCode:
      description: |-
        Enumeration of ISO 3166-1 alpha-2 country codes.

        Attributes:
            (Various country codes like Andorra = "AD", etc.)
      enum:
        - AD
        - AE
        - AF
        - AG
        - AI
        - AL
        - AM
        - AO
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AW
        - AX
        - AZ
        - BA
        - BB
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BL
        - BM
        - BN
        - BO
        - BQ
        - BR
        - BS
        - BT
        - BV
        - BW
        - BY
        - BZ
        - CA
        - CC
        - CD
        - CF
        - CG
        - CH
        - CI
        - CK
        - CL
        - CM
        - CN
        - CO
        - CR
        - CU
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DE
        - DJ
        - DK
        - DM
        - DO
        - DZ
        - EC
        - EE
        - EG
        - EH
        - ER
        - ES
        - ET
        - FI
        - FJ
        - FK
        - FM
        - FO
        - FR
        - GA
        - GB
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GL
        - GM
        - GN
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GW
        - GY
        - HK
        - HM
        - HN
        - HR
        - HT
        - HU
        - ID
        - IE
        - IL
        - IM
        - IN
        - IO
        - IQ
        - IR
        - IS
        - IT
        - JE
        - JM
        - JO
        - JP
        - KE
        - KG
        - KH
        - KI
        - KM
        - KN
        - KP
        - KR
        - KW
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LI
        - LK
        - LR
        - LS
        - LT
        - LU
        - LV
        - LY
        - MA
        - MC
        - MD
        - ME
        - MF
        - MG
        - MH
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NC
        - NE
        - NF
        - NG
        - NI
        - NL
        - 'NO'
        - NP
        - NR
        - NU
        - NZ
        - OM
        - PA
        - PE
        - PF
        - PG
        - PH
        - PK
        - PL
        - PM
        - PN
        - PR
        - PS
        - PT
        - PW
        - PY
        - QA
        - RE
        - RO
        - RS
        - RU
        - RW
        - SA
        - SB
        - SC
        - SD
        - SE
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SR
        - SS
        - ST
        - SV
        - SX
        - SY
        - SZ
        - TC
        - TD
        - TF
        - TG
        - TH
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TR
        - TT
        - TV
        - TW
        - TZ
        - UA
        - UG
        - UM
        - US
        - UY
        - UZ
        - VA
        - VC
        - VE
        - VG
        - VI
        - VN
        - VU
        - WF
        - WS
        - XK
        - YE
        - YT
        - ZA
        - ZM
        - ZW
      title: ISO2CountryCode
      type: string
    v1.InternationalAddressMatchType:
      enum:
        - NO_MATCH
        - REGION
        - CITY
        - COUNTRY
        - EXACT
      title: InternationalAddressMatchType
      type: string
    v1.WebPresenceSource:
      enum:
        - INPUT_WEBSITE
        - FOUND_WEBSITE
        - SOCIAL_PROFILE
        - INPUT_SOCIAL_PROFILE
        - REVIEW
        - DIRECTORY
      type: string
    v1.PhoneNumberMatchType:
      enum:
        - NO_MATCH
        - EXACT
        - AREA_CODE
      title: PhoneNumberMatchType
      type: string
    v1.EmailMatchType:
      enum:
        - NO_MATCH
        - EXACT
        - DOMAIN
      title: EmailMatchType
      type: string
    v1.DiscoveredSocialProfile:
      properties:
        site:
          description: The type of social profile.
          enum:
            - linked_in:personal
            - linked_in:company
            - twitter
            - instagram
            - facebook
            - youtube
            - tiktok
            - pinterest
            - x
          examples:
            - instagram
          type: string
        username:
          description: The username of the social profile.
          examples:
            - certifiedpowerinc
          title: Username
          type: string
        confidence:
          anyOf:
            - $ref: '#/components/schemas/v1.ConfidenceLevel'
            - type: 'null'
          default: null
          description: The confidence level of the social profile.
          examples:
            - high
        metadata:
          anyOf:
            - $ref: '#/components/schemas/v1.DiscoveredInstagramMetadata'
            - $ref: '#/components/schemas/v1.DiscoveredLinkedInMetadata'
            - $ref: '#/components/schemas/v1.DiscoveredFacebookMetadata'
            - $ref: '#/components/schemas/v1.DiscoveredXMetadata'
            - $ref: '#/components/schemas/v1.DiscoveredYouTubeMetadata'
            - $ref: '#/components/schemas/v1.DiscoveredTikTokMetadata'
            - $ref: '#/components/schemas/v1.DiscoveredPinterestMetadata'
            - type: 'null'
          default: null
          description: >-
            The metadata of the social profile.  Based on the site of the social
            profile.
          title: Metadata
        found_on:
          description: >-
            Location(s) where this social profile was found: InputWebsite
            (user-provided website), FoundWebsite (discovered website)
          examples:
            - - FOUND_WEBSITE
            - - INPUT_WEBSITE
              - FOUND_WEBSITE
          items:
            enum:
              - INPUT_WEBSITE
              - FOUND_WEBSITE
            type: string
          title: Found On
          type: array
          uniqueItems: true
        url:
          description: The URL of the social profile.
          examples:
            - https://www.instagram.com/certifiedpowerinc
          readOnly: true
          title: Url
          type: string
      required:
        - site
        - username
        - url
      title: DiscoveredSocialProfile
      type: object
    v1.InputSocialProfileMatch:
      properties:
        site:
          description: The social media platform from the original input.
          enum:
            - linked_in:personal
            - linked_in:company
            - twitter
            - instagram
            - facebook
            - youtube
            - tiktok
            - pinterest
            - x
          examples:
            - instagram
          type: string
        value:
          description: The username, handle, or URL from the original input.
          examples:
            - acme-corp
          title: Value
          type: string
        matched:
          description: >-
            Whether this input social profile was successfully scraped and
            verified during discovery.
          title: Matched
          type: boolean
      required:
        - site
        - value
        - matched
      title: InputSocialProfileMatch
      type: object
    v1.DiscoveredReview:
      properties:
        source:
          anyOf:
            - $ref: '#/components/schemas/v1.ReviewSource'
            - type: 'null'
          default: null
          description: The source of the review.
          examples:
            - yelp
        url:
          description: The URL of the review.
          examples:
            - https://www.yelp.com/biz/certified-power-inc-mundelein
          title: Url
          type: string
        confidence:
          anyOf:
            - $ref: '#/components/schemas/v1.ConfidenceLevel'
            - type: 'null'
          default: high
          description: The confidence level that this review is for the business.
          examples:
            - high
        rating:
          anyOf:
            - maximum: 5
              minimum: 0
              type: number
            - type: 'null'
          default: null
          description: The numeric rating of the review (e.g., 4.5 out of 5).
          examples:
            - 4.5
          title: Rating
        volume:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          default: null
          description: The number of reviews.
          examples:
            - 23
          title: Volume
        summary:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Overall summary of the reviews and general sentiment towards the
            business.
          examples:
            - >-
              5 reviews mention that the service was great and the owner was
              very helpful.
          title: Summary
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          examples:
            - '+12125551234'
          title: Phone Number
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business address if found in profile
          examples:
            - 123 Main St, Anytown, USA
          title: Address
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website if found in profile
          examples:
            - https://www.example.com
          title: Business Website
        reviews:
          description: Individual reviews for this business.
          items:
            $ref: '#/components/schemas/v1.ReviewDetail'
          title: Reviews
          type: array
        metadata:
          anyOf:
            - $ref: '#/components/schemas/v1.GoogleReviewMetadata'
            - type: 'null'
          default: null
          description: >-
            Platform-specific metadata for the review. Currently only populated
            for Google reviews.
      required:
        - url
      title: DiscoveredReview
      type: object
    v1.DiscoveredDirectoryListing:
      description: >-
        A business listing discovered on a directory/aggregator site (BBB, Yelp,
        etc.).


        Captures the NAICS-relevant data extracted from directory pages during

        website discovery.  The ``category`` is the most valuable field —
        directory

        sites like BBB and Yelp assign industry labels that map almost 1-to-1 to

        NAICS codes.
      properties:
        source:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Directory domain where the listing was found.
          examples:
            - bbb.org
            - yelp.com
            - yellowpages.com
          title: Source
        url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: URL of the directory page that was scraped.
          examples:
            - >-
              https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234
          title: Url
        category:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business category assigned by the directory site.
          examples:
            - Plumbing Contractor
            - Italian Restaurant
            - Moving Company
          title: Category
        business_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business name as listed on the directory (may be a DBA).
          examples:
            - Joe's Plumbing & Heating
          title: Business Name
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Phone number from the directory listing.
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Email address from the directory listing.
          title: Email
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Website URL listed on the directory page for the business.
          title: Business Website
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Physical address from the directory listing.
          title: Address
        people:
          description: Officers, principals, or key people listed on the directory page.
          items:
            $ref: '#/components/schemas/v1.DirectoryListingPerson'
          title: People
          type: array
      title: DiscoveredDirectoryListing
      type: object
    v1.WebsiteAnalysisDetails:
      properties:
        id:
          description: The ID of the Website Analysis request
          format: uuid
          title: Id
          type: string
        url:
          description: The website URL that was analyzed as part of the Search.
          examples:
            - http://www.warner.com/
          format: uri
          minLength: 1
          title: Url
          type: string
        redirects:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteRedirectInfo'
            - type: 'null'
          default: null
          description: >-
            Redirect information for this website, if a cross-domain redirect
            was detected.
          examples:
            - is_redirect_url: true
              redirects_to: baselayer.com
        parked:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            A boolean indicating if the website is suspected of being a parked
            domain.
          examples:
            - true
            - false
          title: Parked
        email_deliverable:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            A boolean indicating if the website is able to send and receive
            emails.
          examples:
            - true
            - false
          title: Email Deliverable
        phone_numbers:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: >-
            The list of phone numbers that were identified on the analyzed
            website.
          examples:
            - - 362-345-4551
              - (872) 628-1402
          title: Phone Numbers
        emails:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: >-
            The list of email addresses that were identified on the analyzed
            website.
          examples:
            - - bennettamber@example.org
              - goldenshawn@example.com
          title: Emails
        social_profiles:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.SocialProfile'
              type: array
            - type: 'null'
          description: >-
            The list of social media profiles that were identified on the
            analyzed website.
          examples:
            - - site: twitter
                url: https://twitter.com/michelle98
                username: michelle98
          title: Social Profiles
        addresses:
          default: []
          description: >-
            The list of mailing addresses that were identified on the analyzed
            website.
          items:
            $ref: '#/components/schemas/v1.AddressSummaryResponse'
          title: Addresses
          type: array
        people:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.WebsiteAnalysisPerson'
              type: array
            - type: 'null'
          description: The list of people identified on the analyzed website.
          examples:
            - - name: Jane Smith
                titles:
                  - CEO
                  - Co-Founder
              - name: John Doe
                titles:
                  - CTO
          title: People
        website_build_status:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteBuildStatus'
            - type: 'null'
          default: null
          description: The build status of the website.
        website_summary:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: A summary of the business based on the analyzed website content.
          examples:
            - >-
              Howard Concrete Pumping Co., Inc. is a concrete pumping contractor
              serving the construction industry. The company specializes in
              concrete placement services for residential and commercial
              construction projects. They operate throughout the greater
              metropolitan area and have been providing reliable concrete
              pumping solutions for over 20 years.
          title: Website Summary
        console_url:
          description: The URL to the Website Analysis details in the console.
          examples:
            - >-
              https://console.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis
          format: uri
          maxLength: 2083
          minLength: 1
          title: Console Url
          type: string
        screenshot_url:
          anyOf:
            - format: uri
              maxLength: 2083
              minLength: 1
              type: string
            - type: 'null'
          default: null
          description: The URL to download the homepage screenshot of the analyzed website.
          examples:
            - >-
              https://api.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis/screenshot
          title: Screenshot Url
        whois_record:
          anyOf:
            - $ref: '#/components/schemas/v1.WhoIsRecordResponse'
            - type: 'null'
          default: null
          description: The WHOIS record information for the analyzed website.
        ssl_validity:
          anyOf:
            - $ref: '#/components/schemas/v1.SSLValidityInfo'
            - type: 'null'
          default: null
          description: >-
            The SSL certificate validity information for the analyzed website,
            including fraud-relevant signals.
          examples:
            - cert_age_days: 185
              certificate_type: EV
              days_until_expiry: 180
              expiry_date: '2025-01-15T00:00:00'
              is_revoked: false
              is_self_signed: false
              is_valid: true
              is_wildcard: false
              issued_date: '2024-01-15T00:00:00'
              issuer: DigiCert Global Root CA
              key_size: 2048
              reason: null
              subject: www.example.com
              tls_version: TLSv1.3
            - cert_age_days: 395
              certificate_type: DV
              days_until_expiry: -30
              expiry_date: '2024-01-01T00:00:00'
              is_revoked: false
              is_self_signed: false
              is_valid: false
              is_wildcard: false
              issued_date: '2023-01-01T00:00:00'
              issuer: R3
              key_size: 256
              reason: CERTIFICATE_EXPIRED
              subject: expired.example.com
              tls_version: TLSv1.2
        website_structure_metrics:
          anyOf:
            - $ref: '#/components/schemas/v1.WebsiteStructureMetrics'
            - type: 'null'
          default: null
          description: >-
            Website structure metrics including depth and breadth discovered
            during scraping.
          examples:
            - breadth: 15+
              depth: 2+
            - breadth: '5'
              depth: '1'
            - breadth: '1'
              depth: '0'
      required:
        - id
        - url
        - parked
        - emails
        - social_profiles
        - console_url
      title: WebsiteAnalysisDetails (v1)
      type: object
    v1.PredictedNaicsResponse:
      properties:
        code:
          description: The predicted NAICS code for the business.
          examples:
            - '336111'
          title: Code
          type: string
        title:
          description: The title of the predicted NAICS code.
          examples:
            - Automobile Manufacturing
          title: Title
          type: string
        accuracy:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: The accuracy of the NAICS code prediction.
          examples:
            - 1
            - 0.4
          title: Accuracy
        keywords:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: >-
            Any keywords associated with the NAICS code to indicate area of
            business activity.
          examples:
            - - Automobiles
              - Manufacturing
              - Cars
              - Trucks
          title: Keywords
        mcc_codes:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.MCC'
              type: array
            - type: 'null'
          default: null
          description: List of MCC codes associated with the NAICS code.
          title: Mcc Codes
        sic_codes:
          anyOf:
            - items:
                $ref: '#/components/schemas/v1.SICCode'
              type: array
            - type: 'null'
          default: null
          description: List of SIC codes associated with the NAICS code.
          title: Sic Codes
        risk_level:
          anyOf:
            - $ref: '#/components/schemas/v1.RiskLevel'
            - type: 'null'
          default: null
          description: The risk level associated with the NAICS code.
          examples:
            - low
            - medium
            - high
        reasoning:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Explanation of why this specific NAICS code was chosen for the
            business.
          examples:
            - >-
              Based on homepage content mentioning automobile manufacturing and
              assembly processes.
            - >-
              Reviews and social profiles consistently reference restaurant and
              food service operations.
          title: Reasoning
      required:
        - code
        - title
      title: PredictedNaicsResponse (v1)
      type: object
    v1.ScoreResponse:
      properties:
        type:
          $ref: '#/components/schemas/v1.ScoreType'
          description: The type of score.
          examples:
            - risk
        score:
          description: The score value.
          examples:
            - 95
          title: Score
          type: number
        rating:
          description: The rating associated with the score.
          examples:
            - A
            - B
          title: Rating
          type: string
      required:
        - type
        - score
        - rating
      title: ScoreResponse (v1)
      type: object
    v1.AddressMatchType:
      enum:
        - NO_MATCH
        - CITY
        - STATE
        - SIMILAR
        - EXACT
      title: AddressMatchType
      type: string
    v1.ConfidenceLevel:
      enum:
        - high
        - medium
        - low
      title: ConfidenceLevel
      type: string
    v1.DiscoveredInstagramMetadata:
      description: Instagram-specific metadata extracted from a verified business profile.
      properties:
        is_private:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the Instagram account is private
          examples:
            - false
            - true
          title: Is Private
        is_business_account:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether this is an Instagram business account
          examples:
            - true
            - false
          title: Is Business Account
        has_business_address:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the business address is displayed on the Instagram profile
          examples:
            - true
            - false
          title: Has Business Address
        bio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Instagram bio/description content
          examples:
            - Professional roofing services since 2010 🏠
          title: Bio
        followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          examples:
            - 1250
            - 5000
          title: Followers Count
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          examples:
            - '+12125551234'
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          examples:
            - contact@business.com
          title: Email
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business address if found in profile
          examples:
            - 123 Main St, Anytown, USA
          title: Address
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          examples:
            - https://www.business.com
          title: Business Website
      title: DiscoveredInstagramMetadata
      type: object
    v1.DiscoveredLinkedInMetadata:
      description: LinkedIn-specific metadata extracted from a verified business profile.
      properties:
        company_size_range:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Company size range as displayed on LinkedIn (e.g., '11-50
            employees')
          examples:
            - 11-50 employees
            - 51-200 employees
          title: Company Size Range
        industry:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Industry classification from LinkedIn
          examples:
            - Construction
            - Financial Services
          title: Industry
        followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          examples:
            - 250
            - 1500
          title: Followers Count
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          examples:
            - '+12125551234'
          title: Phone Number
        bio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: LinkedIn bio/description content
          title: Bio
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          examples:
            - info@business.com
          title: Email
        number_of_employees:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of employees (LinkedIn only)
          examples:
            - 25
            - 150
          title: Number Of Employees
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          examples:
            - https://www.business.com
          title: Business Website
      title: DiscoveredLinkedInMetadata
      type: object
    v1.DiscoveredFacebookMetadata:
      description: Facebook-specific metadata extracted from a verified business profile.
      properties:
        is_business_page:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether this is a Facebook business page vs personal profile
          title: Is Business Page
        has_reviews:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the Facebook page has customer reviews
          title: Has Reviews
        check_ins_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of check-ins at this business location
          title: Check Ins Count
        followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          title: Followers Count
        bio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Facebook bio/description content
          title: Bio
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          title: Phone Number
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business address if found in profile
          title: Address
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          title: Email
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          title: Business Website
      title: DiscoveredFacebookMetadata
      type: object
    v1.DiscoveredXMetadata:
      description: Twitter/X-specific metadata extracted from a verified business profile.
      properties:
        is_verified:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the Twitter/X account is verified
          examples:
            - true
            - false
          title: Is Verified
        follower_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          examples:
            - 1500
            - 10000
          title: Follower Count
        bio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Twitter/X bio/description content
          examples:
            - Leading provider of construction services in the NYC area
          title: Bio
        joined_date:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: When the account joined Twitter/X (e.g., 'Joined February 2010')
          examples:
            - Joined February 2010
            - Joined March 2015
          title: Joined Date
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business address if found in profile
          examples:
            - 123 Main St, Anytown, USA
          title: Address
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          examples:
            - '+12125551234'
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          examples:
            - contact@business.com
          title: Email
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          examples:
            - https://www.business.com
          title: Business Website
      title: DiscoveredXMetadata
      type: object
    v1.DiscoveredYouTubeMetadata:
      description: YouTube-specific metadata extracted from a verified business channel.
      properties:
        is_verified:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the YouTube channel is verified
          examples:
            - true
            - false
          title: Is Verified
        subscriber_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of subscribers if displayed
          examples:
            - 1200
            - 15000
          title: Subscriber Count
        channel_type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Type of channel (e.g., 'Business', 'Brand', 'Personal')
          examples:
            - Business
            - Brand
            - Personal
          title: Channel Type
        has_business_email:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether business contact email is provided
          examples:
            - true
            - false
          title: Has Business Email
        channel_description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Channel about/description content
          examples:
            - Weekly tutorials on home improvement and DIY projects
          title: Channel Description
        followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          examples:
            - 1200
            - 15000
          title: Followers Count
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          examples:
            - '+12125551234'
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          examples:
            - business@example.com
          title: Email
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          examples:
            - https://www.business.com
          title: Business Website
      title: DiscoveredYouTubeMetadata
      type: object
    v1.DiscoveredTikTokMetadata:
      description: TikTok-specific metadata extracted from a verified business profile.
      properties:
        is_verified:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the TikTok account is verified
          examples:
            - true
            - false
          title: Is Verified
        is_business_account:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether this is a TikTok business account
          examples:
            - true
            - false
          title: Is Business Account
        follower_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          examples:
            - 5000
            - 25000
          title: Follower Count
        bio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: TikTok bio/description content
          examples:
            - Your trusted local contractor 🔨 Follow for tips!
          title: Bio
        has_business_website:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether a business website link is provided
          examples:
            - true
            - false
          title: Has Business Website
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          examples:
            - '+12125551234'
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          examples:
            - contact@business.com
          title: Email
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          examples:
            - https://www.business.com
          title: Business Website
      title: DiscoveredTikTokMetadata
      type: object
    v1.DiscoveredPinterestMetadata:
      description: Pinterest-specific metadata extracted from a verified business profile.
      properties:
        follower_count:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Number of followers if displayed
          title: Follower Count
        monthly_views:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Monthly views count if displayed
          title: Monthly Views
        bio:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Pinterest profile bio/description content
          title: Bio
        has_business_website:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether a business website link is provided
          title: Has Business Website
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business phone number if found in profile
          title: Phone Number
        email:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business email address if found in profile
          title: Email
        business_website:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business website URL if found in profile
          title: Business Website
      title: DiscoveredPinterestMetadata
      type: object
    v1.ReviewSource:
      enum:
        - yelp
        - google
        - trustpilot
        - tripadvisor
        - other
      title: ReviewSource
      type: string
    v1.ReviewDetail:
      properties:
        username:
          description: The username of the reviewer.
          examples:
            - John Doe
          title: Username
          type: string
        text:
          description: The text of the review.
          examples:
            - This is a great review!
          title: Text
          type: string
        date:
          description: The date of the review.
          examples:
            - '2024-01-01'
          format: date
          title: Date
          type: string
        rating:
          description: The rating of the review.
          examples:
            - 5
          title: Rating
          type: integer
      required:
        - username
        - text
        - date
        - rating
      title: ReviewDetail
      type: object
    v1.GoogleReviewMetadata:
      description: Google Maps-specific metadata for a discovered review.
      properties:
        open_state:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Current open/closed state from Google Maps.
          examples:
            - Open
            - Closed
            - Temporarily closed
          title: Open State
        operating_hours:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: Operating hours data from Google Maps.
          title: Operating Hours
        description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Business description from Google Maps.
          title: Description
        types:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: Business type tags from Google Maps.
          examples:
            - - Restaurant
              - Italian restaurant
          title: Types
        service_options:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: Service options from Google Maps (e.g., dine-in, takeout).
          title: Service Options
      title: GoogleReviewMetadata
      type: object
    v1.DirectoryListingPerson:
      description: An officer, principal, or key person listed on a directory page.
      properties:
        name:
          type: string
          title: Name
        title:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Title
      required:
        - name
      title: DirectoryListingPerson
      type: object
    v1.WebsiteRedirectInfo:
      properties:
        is_redirect_url:
          description: Indicates that this website performs a cross-domain redirect.
          examples:
            - true
          title: Is Redirect Url
          type: boolean
        redirects_to:
          description: The domain this website redirects to.
          examples:
            - baselayer.com
          title: Redirects To
          type: string
      required:
        - is_redirect_url
        - redirects_to
      title: WebsiteRedirectInfo (v1)
      type: object
    v1.SocialProfile:
      properties:
        site:
          description: The type of social profile.
          enum:
            - linked_in:personal
            - linked_in:company
            - twitter
            - instagram
            - facebook
            - youtube
            - tiktok
            - pinterest
            - x
          examples:
            - instagram
          type: string
        username:
          description: The username of the social profile.
          examples:
            - certifiedpowerinc
          title: Username
          type: string
        url:
          description: The URL of the social profile.
          examples:
            - https://www.instagram.com/certifiedpowerinc
          readOnly: true
          title: Url
          type: string
      required:
        - site
        - username
        - url
      title: SocialProfile
      type: object
    v1.AddressSummaryResponse:
      description: |-
        Response model for address summary data.

        This model defines the structure for address summary API responses.
      properties:
        id:
          description: Unique identifier for the address.
          format: uuid
          title: Id
          type: string
        street:
          description: Street name of the address.
          examples:
            - 913 Hendrix Gardens Suite 492
          title: Street
          type: string
        city:
          description: City name of the address.
          examples:
            - Jasonfurt
          title: City
          type: string
        state:
          $ref: '#/components/schemas/v1.StateAbbreviation'
          description: State 2 letter abbreviation of the address.
          examples:
            - VA
        zip:
          description: Zip code of the address.
          examples:
            - '19773'
          title: Zip
          type: string
        latitude:
          description: Latitude of the address.
          examples:
            - 38.03012
          title: Latitude
          type: number
        longitude:
          description: Longitude of the address.
          examples:
            - 78.47665
          title: Longitude
          type: number
        rdi:
          anyOf:
            - $ref: '#/components/schemas/v1.AddressRDI'
            - type: 'null'
          default: null
          description: Residential Delivery Indicator of the address.
          examples:
            - Commercial
        deliverable:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Indicates whether the address is deliverable.
          examples:
            - false
          title: Deliverable
        cmra:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Indicates whether the address is a Commercial Mail Receiving Agency
            (CMRA).
          examples:
            - false
          title: Cmra
        url:
          anyOf:
            - format: uri
              maxLength: 2083
              minLength: 1
              type: string
            - type: 'null'
          default: null
          description: The URL to the address details.
          title: Url
        delivery_type:
          anyOf:
            - $ref: '#/components/schemas/v1.USPSDeliveryType'
            - type: 'null'
          default: null
          description: The USPS delivery type.
          examples:
            - STREET
            - FIRM
      required:
        - id
        - street
        - city
        - state
        - zip
        - latitude
        - longitude
      title: AddressSummaryResponse (v1)
      type: object
    v1.WebsiteAnalysisPerson:
      properties:
        name:
          type: string
          title: Name
        titles:
          items:
            type: string
          title: Titles
          type: array
          uniqueItems: true
      required:
        - name
        - titles
      title: WebsiteAnalysisPerson
      type: object
    v1.WebsiteBuildStatus:
      enum:
        - coming_soon
        - inactive
        - active
      title: WebsiteBuildStatus
      type: string
    v1.WhoIsRecordResponse:
      properties:
        domain_created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The date and time when the domain was first registered.
          examples:
            - '2020-05-15T10:30:00Z'
          title: Domain Created At
        domain_age_months:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: The age of the domain since its creation in months.
          examples:
            - 15
          title: Domain Age Months
        domain_updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The date and time when the domain registration was last updated.
          examples:
            - '2023-06-01T14:45:00Z'
          title: Domain Updated At
        domain_expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The date and time when the domain registration is set to expire.
          examples:
            - '2025-05-15T10:30:00Z'
          title: Domain Expires At
        registrar:
          anyOf:
            - type: string
            - type: 'null'
          description: The name of the domain registrar.
          examples:
            - Example Registrar Inc.
          title: Registrar
      required:
        - domain_created_at
        - domain_updated_at
        - domain_expires_at
        - registrar
      title: WhoIsRecordResponse (v1)
      type: object
    v1.SSLValidityInfo:
      description: |-
        SSL certificate information with fraud-relevant signals.

        is_valid semantics:
            True:  Certificate is valid and trusted
            False: Certificate is definitively invalid (expired, untrusted, revoked, etc.)
            None:  Cannot determine (connection failed, timeout, non-HTTPS)
      properties:
        is_valid:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Whether the SSL certificate is valid (True=valid, False=invalid,
            None=indeterminate)
          title: Is Valid
        reason:
          anyOf:
            - $ref: '#/components/schemas/v1.SSLInvalidReason'
            - type: 'null'
          default: null
          description: Reason if SSL certificate is invalid or indeterminate
          examples:
            - CERTIFICATE_EXPIRED
            - HOSTNAME_MISMATCH
            - SELF_SIGNED
            - UNABLE_TO_CONNECT
        issuer:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Certificate issuer (CA) common name
          examples:
            - DigiCert Global Root CA
            - R3
          title: Issuer
        subject:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Certificate subject common name
          examples:
            - www.example.com
            - '*.example.com'
          title: Subject
        issued_date:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          default: null
          description: When the certificate was issued
          title: Issued Date
        expiry_date:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          default: null
          description: When the certificate expires
          title: Expiry Date
        days_until_expiry:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Days until certificate expires (negative if expired)
          examples:
            - 365
            - 30
            - -5
          title: Days Until Expiry
        cert_age_days:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Days since certificate was issued
          examples:
            - 180
            - 30
            - 5
          title: Cert Age Days
        certificate_type:
          anyOf:
            - $ref: '#/components/schemas/v1.SSLCertificateType'
            - type: 'null'
          default: null
          description: >-
            Certificate validation level (DV=Domain only, OV=Organization
            verified, EV=Extended validation)
          examples:
            - DV
            - EV
        is_wildcard:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether this is a wildcard certificate (*.example.com)
          title: Is Wildcard
        key_size:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Public key size in bits
          examples:
            - 2048
            - 4096
            - 256
          title: Key Size
        tls_version:
          anyOf:
            - $ref: '#/components/schemas/v1.TLSVersion'
            - type: 'null'
          default: null
          description: TLS protocol version used
          examples:
            - TLSv1.2
            - TLSv1.3
        is_self_signed:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the certificate is self-signed (not trusted by a CA)
          title: Is Self Signed
        is_revoked:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: Whether the certificate has been revoked (via OCSP check)
          title: Is Revoked
      title: SSLValidityInfo
      type: object
    v1.WebsiteStructureMetrics:
      description: |-
        Website structure metrics discovered during scraping.

        Formatted as strings for display:
        - depth: "0", "1", or "2+"
        - breadth: actual count as string or "15+"
      properties:
        depth:
          description: >-
            Maximum depth reached: '0' (homepage only), '1' (one level), or '2+'
            (structured site)
          examples:
            - '0'
            - '1'
            - 2+
          title: Depth
          type: string
        breadth:
          description: >-
            Total unique pages discovered: actual count or '15+' for substantial
            sites
          examples:
            - '5'
            - '12'
            - 15+
          title: Breadth
          type: string
      required:
        - depth
        - breadth
      title: WebsiteStructureMetrics
      type: object
    v1.MCC:
      description: Represents a Merchant Category Code (MCC).
      properties:
        code:
          description: The 4-digit MCC.
          title: Code
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Description of the MCC.
          title: Description
        mastercard_risk:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            Indicates if there is a risk associated with Mastercard
            transactions.
          title: Mastercard Risk
        visa_risk_tier:
          anyOf:
            - $ref: '#/components/schemas/v1.VisaRiskTier'
            - type: 'null'
          default: null
          description: The Visa risk tier associated with this MCC.
      required:
        - code
      title: MCC
      type: object
    v1.SICCode:
      description: Represents a Standard Industrial Classification (SIC) code.
      properties:
        code:
          description: The 4-digit SIC code.
          title: Code
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Description of the SIC code.
          title: Description
      required:
        - code
      title: SICCode
      type: object
    v1.RiskLevel:
      enum:
        - high
        - medium
        - low
        - no_risk
      title: RiskLevel
      type: string
    v1.ScoreType:
      enum:
        - fraud
        - risk
        - kyb
      title: ScoreType
      type: string
    v1.StateAbbreviation:
      enum:
        - AL
        - AK
        - AZ
        - AR
        - CA
        - CO
        - CT
        - DE
        - DC
        - FL
        - GA
        - HI
        - ID
        - IL
        - IN
        - IA
        - KS
        - KY
        - LA
        - ME
        - MD
        - MA
        - MI
        - MN
        - MS
        - MO
        - MT
        - NE
        - NV
        - NH
        - NJ
        - NM
        - NY
        - NC
        - ND
        - OH
        - OK
        - OR
        - PA
        - RI
        - SC
        - SD
        - TN
        - TX
        - UT
        - VT
        - VA
        - WA
        - WV
        - WI
        - WY
        - PR
        - VI
        - AE
        - AA
        - AP
        - GU
        - AS
      title: StateAbbreviation
      type: string
    v1.AddressRDI:
      enum:
        - Residential
        - Commercial
      title: AddressRDI
      type: string
    v1.USPSDeliveryType:
      description: |-
        Enum representing the different types of USPS delivery points.
        Used to classify addresses based on how mail is delivered to them.
      enum:
        - FIRM
        - GENERAL_DELIVERY
        - HIGH_RISE
        - POST_OFFICE
        - RURAL_ROUTE
        - STREET
      title: USPSDeliveryType
      type: string
    v1.SSLInvalidReason:
      description: >-
        Reasons why an SSL certificate check failed or could not be determined.


        Used when is_valid is False (certificate invalid) or None
        (indeterminate).
      enum:
        - CERTIFICATE_EXPIRED
        - HOSTNAME_MISMATCH
        - SELF_SIGNED
        - REVOKED
        - UNTRUSTED_AUTHORITY
        - VERIFICATION_FAILED
        - NOT_HTTPS
        - CONNECTION_TIMED_OUT
        - UNABLE_TO_CONNECT
        - SERVER_DISCONNECTED
        - SERVER_ERROR
        - CONNECTION_ERROR
      title: SSLInvalidReason
      type: string
    v1.SSLCertificateType:
      description: >-
        Type of SSL certificate based on validation level.


        DV (Domain Validation): Only domain ownership verified - easiest to
        obtain

        OV (Organization Validation): Organization identity verified

        EV (Extended Validation): Extensive organization verification - highest
        trust
      enum:
        - DV
        - OV
        - EV
        - Unknown
      title: SSLCertificateType
      type: string
    v1.TLSVersion:
      description: TLS protocol version used for SSL connections.
      enum:
        - TLSv1.0
        - TLSv1.1
        - TLSv1.2
        - TLSv1.3
        - SSLv3
        - Unknown
      title: TLSVersion
      type: string
    v1.VisaRiskTier:
      enum:
        - 1
        - 2
        - 3
      title: VisaRiskTier
      type: integer
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````