---
title: "Name Match"
method: GET
path: "/v1/name-match"
tags: ["KYC APIs"]
---

# Name Match

`GET /v1/name-match`

Name Matching is the process of finding occurrences of a substring from one name in another. It involves comparing patterns against the text to identify matches or similarities, and gives a score for that.

Use this API to verify names that have enormous variations. Provide us the names you want to verify, and we will tell you whether they match and provide score.

## Query parameters

- `name1` string, required
- `name2` string, required

## Response `200`

Successful Response

- RESPONSENAMEMATCHING
  - `code` integer
  - `sub_code` string
  - `message` string
  - `timestamp` integer, required
  - `transaction_id` string, required
  - `data` NameMatchingData, required
    - `cleaned_name1` string, required
    - `cleaned_name2` string, required
    - `score` integer, required
    - `tokenwise_match` object[], required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide.md) · [All operations](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/deepvue/deepvue-tech-developers-guide/revisions/c1b0558e7d77/schema)