Skip to main content
POST
companies.name.match

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
nameA
string
required

First company name.

Required string length: 1 - 512
nameB
string
required

Second company name to compare.

Required string length: 1 - 512

Response

The result

nameA
string
required

Name a.

nameB
string

Name b.

confidence
number

Confidence.

similarityScoresJaroWinkler
number

Similarity scores jaro winkler.

similarityScoresLevenshtein
number

Similarity scores levenshtein.

similarityScoresTokenOverlap
number

Similarity scores token overlap.

match
boolean

True when match.

normalizedA
string

Normalized a.

normalizedB
string

Normalized b.

suffixesRemovedA
string[]

Suffixes removed a.

suffixesRemovedB
string[]

Suffixes removed b.