Run name matching

Production

https://api.niva.co/v1

POST

/utilities/matcher/name

Checks whether two names refer to the same person or company, with the comparison Niva's own checks use. person compares people's names; company compares business names and ignores the legal entity suffix (e.g. S.A. de C.V.). Each name must be at least 4 characters long.

Request

Authorization

Add parameter in header

apiKey

Example:

apiKey: ********************

Header Params

Body Params application/jsonRequired

Examples

Company namesPerson names

{
    "names": [
        "DISEÑO DE FORMAS METALICAS",
        "DISEÑO DE FORMAS METALICAS S DE RL DE CV"
    ],
    "entity_type": "company"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Company namesPerson names

curl --location 'https://api.niva.co/v1/utilities/matcher/name' \
--header 'Accept-Language: en' \
--header 'apiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "names": [
        "DISEÑO DE FORMAS METALICAS",
        "DISEÑO DE FORMAS METALICAS S DE RL DE CV"
    ],
    "entity_type": "company"
}'

Responses

🟢201Created

application/json

Success

Bodyapplication/json

Example

{
  "names": [
    "DISEÑO DE FORMAS METALICAS",
    "DISEÑO DE FORMAS METALICAS S DE RL DE CV"
  ],
  "entity_type": "company",
  "match": true
}

🟠401Unauthorized

🟠422Unprocessable Content

🔴500Internal Server Error

Matcher