POST
/
custom
/
sample
/
match
[
  {
    "record": {
      "code": "HEPP37ST",
      "company_name": "HEPPNER - SOCIETE DE TRANSPORTS",
      "SIREN": "763200202",
      "VAT_number": "FR42169800202",
      "city": "ST PIERRE DES CORPS",
      "postal_code": "37700",
      "country": "FR",
      "email": "jean-michel@heppner-group.com"
    },
    "similarity": 0.95
  },
  {
    "record": {
      "code": "HEPP75PA",
      "company_name": "HEPPNER TRANSPORT SAS",
      "SIREN": "763200203",
      "VAT_number": "FR42169800203",
      "city": "PARIS",
      "postal_code": "75001",
      "country": "FR",
      "email": "contact@heppner-group.com"
    },
    "similarity": 0.85
  }
]

Body

application/json
​
record
object
required

Record to match against the database

Example:
{
  "SIREN": "763200202",
  "VAT_number": "FR42169800202",
  "city": "ST PIERRE DES CORPS",
  "company_name": "HEPPNER - SOCIETE DE TRANSPORTS",
  "country": "FR",
  "email": "jean-michel@heppner-group.com",
  "postal_code": "37700",
  "reasoning___VAT_number": "Found VAT number FR42169800202 in header of the document."
}
​
k
integer
default:20

Number of matching results to return

Required range: 1 <= x <= 100
Example:

20

Response

200
application/json
Successful matching results
​
record
object
required

The matched record containing company information

Example:
{
  "SIREN": "763200202",
  "VAT_number": "FR42169800202",
  "city": "ST PIERRE DES CORPS",
  "company_name": "HEPPNER - SOCIETE DE TRANSPORTS",
  "country": "FR",
  "email": "jean-michel@heppner-group.com",
  "postal_code": "37700",
  "reasoning___VAT_number": "Found VAT number FR42169800202 in header of the document."
}
​
similarity
number
required

Similarity score between 0 and 1, where 1 indicates a perfect match

Required range: 0 <= x <= 1
Example:

0.95