Skip to main content
POST
Watch for newly matching French companies

Authorizations

x-api-key
string
header
required

Body

application/json
countryCode
enum<string>
required

Search monitoring is currently available for France.

Available options:
FR
Example:

"FR"

query
string
required

Company name to watch. Supply address constraints separately. Every word must match; punctuation and accents are ignored.

Example:

"Dupont Conseil"

address
object

Every supplied address constraint must match. Missing address data does not match.

expiresAt
string

Expiration, at most 30 days from creation. Defaults to 30 days.

metadata
object

Customer metadata echoed in match notifications.

Response

id
string
required
countryCode
enum<string>
required
Available options:
FR
query
string
required
status
enum<string>
required
Available options:
active,
stopped,
expired
createdAt
string<date-time>
required
expiresAt
string<date-time>
required
initialMatches
object[]
required

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.

address
object
lastCheckedAt
string<date-time>
lastError
string

Why the latest check failed, for example a name that now matches too many companies. Checks continue hourly; absent once a check succeeds.

metadata
object