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

# Watch for newly matching French companies

> Opt-in beta. Watches a company name and optional address constraints without a registration number. Checks hourly, subject to register publication and search availability. Existing matches form the baseline; new matching IDs trigger search_monitor.match webhooks. Reposting the same query retrieves its subscription. No company data or documents are purchased.



## OpenAPI

````yaml post /v2/search-monitors
openapi: 3.0.0
info:
  title: Topograph
  description: The Topograph API
  version: '0.1'
  contact: {}
servers:
  - url: https://api.topograph.co
security:
  - x-api-key: []
tags: []
paths:
  /v2/search-monitors:
    post:
      tags:
        - Search monitors
      summary: Watch for newly matching French companies
      description: >-
        Opt-in beta. Watches a company name and optional address constraints
        without a registration number. Checks hourly, subject to register
        publication and search availability. Existing matches form the baseline;
        new matching IDs trigger search_monitor.match webhooks. Reposting the
        same query retrieves its subscription. No company data or documents are
        purchased.
      operationId: SearchMonitoringController_create_v2
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSearchMonitorDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSearchMonitorResponseDto'
        '400':
          description: Invalid, overly broad query, expiry, or beta capacity reached.
        '403':
          description: Search monitoring is not enabled for this account.
      security:
        - x-api-key: []
components:
  schemas:
    CreateSearchMonitorDto:
      type: object
      properties:
        countryCode:
          type: string
          enum:
            - FR
          example: FR
          description: Search monitoring is currently available for France.
        query:
          type: string
          example: Dupont Conseil
          description: >-
            Company name to watch. Supply address constraints separately. Every
            word must match; punctuation and accents are ignored.
        address:
          description: >-
            Every supplied address constraint must match. Missing address data
            does not match.
          allOf:
            - $ref: '#/components/schemas/SearchMonitorAddressDto'
        expiresAt:
          type: string
          description: Expiration, at most 30 days from creation. Defaults to 30 days.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Customer metadata echoed in match notifications.
      required:
        - countryCode
        - query
    CreateSearchMonitorResponseDto:
      type: object
      properties:
        id:
          type: string
        countryCode:
          type: string
          enum:
            - FR
        query:
          type: string
        address:
          $ref: '#/components/schemas/SearchMonitorAddressDto'
        status:
          type: string
          enum:
            - active
            - stopped
            - expired
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
        lastCheckedAt:
          type: string
          format: date-time
        lastError:
          type: string
          description: >-
            Why the latest check failed, for example a name that now matches too
            many companies. Checks continue hourly; absent once a check
            succeeds.
        metadata:
          type: object
          additionalProperties:
            type: string
        initialMatches:
          description: >-
            Previously observed matches. On first creation these form the
            baseline and are not sent as new-match webhooks. Reposting returns
            the existing subscription and its remembered matches.
          type: array
          items:
            $ref: '#/components/schemas/SearchMonitorCandidateDto'
      required:
        - id
        - countryCode
        - query
        - status
        - createdAt
        - expiresAt
        - initialMatches
    SearchMonitorAddressDto:
      type: object
      properties:
        addressLine1:
          type: string
          example: 10 rue de la Paix
        city:
          type: string
          example: Saint-Malo
        postalCode:
          type: string
          example: '35400'
    SearchMonitorCandidateDto:
      type: object
      properties:
        id:
          type: string
          example: '932884117'
        countryCode:
          type: string
          enum:
            - FR
        legalName:
          type: string
          example: DUPONT CONSEIL
        address:
          $ref: '#/components/schemas/SearchMonitorAddressDto'
      required:
        - id
        - countryCode
        - legalName
        - address
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.