---
title: "Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming"
method: GET
path: "/api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}"
tags: ["chinese"]
---

# Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming

`GET /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}`

## Request

- Base URL: `https://v2.namsor.com/NamSorAPIv2`
- URL: `https://v2.namsor.com/NamSorAPIv2/api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}`
- Auth: API key in header `X-API-KEY`

## Path parameters

- `chineseSurnameLatin` string, required
- `chineseGivenNameLatin` string, required
- `chineseName` string, required

## Response `200`

A romanized name.

- NameMatchedOut: Classified matched names
  - `script` string
  - `id` string
  - `explanation` string
  - `matchStatus` 'Match' | 'Mismatch': The name matching status.
  - `score` number, double

## Other responses

- `401`: Missing or incorrect API Key
- `403`: Email not Verified, or API Limit Reached, or API Key Disabled
- `429`: Too Many Requests

## Changes

- **2025-05-16** `6297d39b756d`: 2 info
  - added the non-success response with the status `429`
  - added the optional property `explanation` to the response with the `200` status
- **2022-08-19** `c084be2dba5a`: 2 warning
  - added the new `Match` enum value to the `matchStatus` response property for the response status `200`
  - added the new `Mismatch` enum value to the `matchStatus` response property for the response status `200`

[Operation history](https://skmtc.dev/namsor/apis/namsor-api-v2/changes/api2/json/chineseNameMatch/:chineseSurnameLatin/:chineseGivenNameLatin/:chineseName/get.md)

---

[API](https://skmtc.dev/namsor/apis/namsor-api-v2.md) - [All operations](https://skmtc.dev/namsor/apis/namsor-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/namsor/apis/namsor-api-v2/revisions/305e4f6eeaf5?raw)