---
title: China Resident ID Card Verification
slug: us-apis/china-resident-id-card-verification
createdAt: 2024-04-25T10:37:46.812Z
---

# Overview and Purpose

## Overview

The **China National ID Verification API** is a specialized digital tool designed specifically for businesses operating within China. This API provides crucial support in confirming the authenticity of personal information against official Chinese records, enhancing trust, accuracy, and compliance across various sectors.

## Use Cases

- **Identity Verification**: Useful for businesses and financial institutions to authenticate the identity of individuals during account creation, loan application processing, or other identity verification procedures.
- **Compliance Checks**: Assists organizations in complying with regulatory requirements by ensuring all customer identities are verified against official government databases.
- **Fraud Prevention**: Helps prevent fraudulent activities by confirming the authenticity of personal identity information provided by users.

# API Details

**API Overview:**

The Verification API enables the validation of various personal data inputs, including Full Name, Date Of Birth, National ID Number. Each input is cross-referenced against authorized sources to provide a overall **Verified / Not Verified Result.&#x20;**

**Note - The Name must be provided in Chinese**

**Authorization:**

Access to this API is granted via an Authorization Token, ensuring secure and authenticated access for authorized users.

## Request Body

:::CodeblockTabs
PreProduction

```json
curl --location 'https://api-preproduction.signzy.app/api/v3/global-kyc-verify/cn/nid' \
--header 'Authorization: <----Auth Token---->' \
--header 'Content-Type: application/json' \
--data '{
    "fullName": "",
    "dateOfBirth": "",
    "identityInformation": {
        "nationalIdNumber": ""
    },
    "consent": true
}'
```

Production

```json
curl --location 'https://api.signzy.app/api/v3/global-kyc-verify/cn/nid' \
--header 'Authorization: <---Auth Token----' \
--header 'Content-Type: application/json' \
--data '{
    "fullName": "Gou Yunnian",
    "dateOfBirth": "1961-12-05",
    "identityInformation": {
        "nationalIdNumber": "442521196112052420"
    },
    "consent": true
}'

```
:::

## Request Body Parameters

| Parameter        | Type    | Description                                                                 | Required/Optional |
| ---------------- | ------- | --------------------------------------------------------------------------- | ----------------- |
| fullName         | String  | The full name of the person<br />**Note - The fullName must be in chinese** | Required          |
| dateOfBirth      | String  | Date of birth of the person in yyyy-mm-dd format                            | Required          |
| nationalIdNumber | String  | Needs to be **18-digit PRC** code                                           | Required          |
| consent          | Boolean | Consent of the end user for verification of his/her data                    | Required          |

## Response Body

```json
{
    "result": {
        "verificationResult": {
            "fullName": "NA",
            "dateOfBirth": "NA",
            "nationalIdNumber": "NA"
        },
        "sourceVerificationStatus": "Verified"
    }
}
```

To maintain consistency across all the KYC APIs the output parameters of fullName, dateOfBirth and nationalIdNumber would be "NA" while the main reference point would be sourceVerificationStatus.

## Response Body Parameters

| **Parameter**              | **Description**                                                         | **Data Type** |
| -------------------------- | ----------------------------------------------------------------------- | ------------- |
| `fullName`                 | The API returns a "NA" to maintain consistency across all the KYC APIs. | string        |
| `dateOfBirth`              | The API returns a "NA" to maintain consistency across all the KYC APIs. | string        |
| `nationaIdNumber`          | The API returns a "NA" to maintain consistency across all the KYC APIs. | string        |
| `sourceVerificationStatus` | Gives "Verified/Not Verified/Unable to Verify" response                 | string        |

## Error Code and Response Mapping

:::CodeblockTabs
400 (Bad Request)

```json
{
  "error": {
     "name": "error",
     "message": "Bad Input and description ",
     "status": 400,
     "reason": "VALIDATION_ERROR",
     "type": "Bad Request",
     "statusCode": 400
  }
}
```

401(Unauthorized)

```json
{
  "error": {
     "name": "error",
     "message": "Invalid authentication credentials",
     "status": 401,
     "reason": "AUTHENTICATION_ERROR",
     "type": "Bad Request",
     "statusCode": 401
  }
}
```

403 (Forbidden)

```json
{
  "error": {
     "name": "error",
     "message": "Forbidden",
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": "403"
  }
}
```

500 (Internal Server Error)

```json
{
  "error": {
     "name": "error",
     "message": "Internal server error",
     "status": 500,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 500
  }
}
```

409(Upstream Down

```json
{
  "error": {
     "name": "error",
     "message": "Upstream Down",
     "status": 409,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 409
  }
}
```
:::

| **Field**    | **Type** | **Description**                                     |
| ------------ | -------- | --------------------------------------------------- |
| `name`       | string   | Text displayed on the screen explaining error type. |
| `reason`     | string   | Reason for the error.                               |
| `status`     | number   | HTTP status code.                                   |
| `message`    | string   | Error message indicating an upstream error.         |
| `type`       | string   | Error type.                                         |
| `statusCode` | number   | Status code representing the error scenario.        |

:::hint{type="info"}
### Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [help@signzy.com](#). We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
:::

