China National ID Check

Request

Method: POST

URL: https://{{environment}}.ridx.io/cvs/v2/cnid

Headers

Header	Value
token	{{access_token}}
Content-Type	application/json

Request Body

Property	Type	Description
fullName	String	Full name of card holder
idCardNo	String	Number on national ID card must be 18 characters
dateOfBirth	String	Card holder date of birth, in the format: yyyy-mm-dd

Important Response Data

Property	Type	Description
safeHarbour	Boolean	Indicates whether the identity has been validated against the Primary Search AND has cleared a Watchlist check
status	Number	The score indicating the match on the payload data (see "Status number" below)
identityVerified	Boolean	Indicates whether the source document was verified
returnedData.address	String	The province address of the individual
verifications.XXXX	Boolean	Each field has a Boolean value indicating whether that field was verified against the searched data sources or not

Status numbers

• 0: A full match on the identity has been returned
• 1: The Identity was matched, but the name provided was incorrect
• 2: All information provided was incorrect
• 3: The data source being utilised is not working

Example Requests

Example Request ( Status = 0 )Example Request ( Status = 1 )Example Request ( Status = 2 )Example Request ( Status = 3 )Example Request ( Error response )

{
  "fullName": "黄俊龙",
  "dateOfBirth": "1988-07-22",
  "idCardNo": "422822198807221010"
}

{
  "fullName": "黄俊龙",
  "dateOfBirth": "1988-07-22",
  "idCardNo": "422822198807221011"
}

{
  "fullName": "黄俊龙",
  "dateOfBirth": "1988-07-22",
  "idCardNo": "422822198807221012"
}

{
  "fullName": "黄俊龙",
  "dateOfBirth": "1988-07-22",
  "idCardNo": "422822198807221013"
}

{
  "fullName": "黄俊龙",
  "idCardNo": "422822198807221014"
}

Example Responses

Success response ( Status = 0 )Success response ( Status = 1 )Success response ( Status = 2 )Failed response ( Status = 3 )Error Response

Status: 200 OK

{
  "countryCode": "China",
  "clientReference": "",
  "reportingReference": "XX-XXX-XXXXXXXXXXXXXXX",
  "matchStatus": "Full Match 1+1 Verification",
  "searchErrorMessage": "",
  "safeHarbour": false,
  "searchStatus": "Successful",
  "serviceResponses": {
    "China ID Verification": {
      "status": 0,
      "sourceStatus": "Successful",
      "errorMessage": "",
      "identityVerified": true,
      "safeHarbourScore": "XX",
      "nameMatchScore": "1.000",
      "addressMatchScore": "N/A",
      "verifications": {
        "dateOfBirth": true,
        "fullName": true,
        "idCardNo": true
      },
      "returnedData": {
        "address": "XX-XXX-XXXXXXXXXXXXXXX",
        "gender": "XX"
      }
    }
  },
  "remarks": [],
  "rapidID": "check-id"
}

Status: 200 OK

{
  "status": 200,
  "message": "ok",
  "data": {
    "countryCode": "China",
    "clientReference": "",
    "reportingReference": "XX-XXX-XXXXXXXXXXXXXXX",
    "matchStatus": "No Match",
    "searchErrorMessage": "",
    "safeHarbour": false,
    "searchStatus": "Successful",
    "serviceResponses": {
      "China ID Verification": {
        "status": 1,
        "sourceStatus": "Successful",
        "errorMessage": "",
        "identityVerified": false,
        "safeHarbourScore": "none",
        "nameMatchScore": "N/A",
        "addressMatchScore": "N/A",
        "verifications": {
          "dateOfBirth": false,
          "fullName": false,
          "idCardNo": false
        },
        "returnedData": {}
      }
    },
    "remarks": [],
    "rapidID": "check-id"
  }
}

Status: 200 OK

{
  "status": 200,
  "message": "ok",
  "data": {
    "countryCode": "China",
    "clientReference": "",
    "reportingReference": "XX-XXX-XXXXXXXXXXXXXXX",
    "matchStatus": "No Match",
    "searchErrorMessage": "",
    "safeHarbour": false,
    "searchStatus": "Successful",
    "serviceResponses": {
      "China ID Verification": {
        "status": 2,
        "sourceStatus": "Successful",
        "errorMessage": "",
        "identityVerified": false,
        "safeHarbourScore": "none",
        "nameMatchScore": "N/A",
        "addressMatchScore": "N/A",
        "verifications": {
          "dateOfBirth": false,
          "fullName": false,
          "idCardNo": false
        },
        "returnedData": {}
      }
    },
    "remarks": [],
    "rapidID": "check-id"
  }
}

Status: 200 OK

{
  "status": 200,
  "message": "ok",
  "data": {
    "countryCode": "China",
    "clientReference": "",
    "reportingReference": "XX-XXX-XXXXXXXXXXXXXXX",
    "matchStatus": "No Match",
    "searchErrorMessage": "",
    "safeHarbour": false,
    "searchStatus": "Successful",
    "serviceResponses": {
      "China ID Verification": {
        "status": 3,
        "sourceStatus": "Successful",
        "errorMessage": "",
        "identityVerified": false,
        "safeHarbourScore": "none",
        "nameMatchScore": "N/A",
        "addressMatchScore": "N/A",
        "verifications": {
          "dateOfBirth": false,
          "fullName": false,
          "idCardNo": false
        },
        "returnedData": {}
      }
    },
    "remarks": [],
    "rapidID": "check-id"
  }
}

Status: 400 Bad Request

{
  "status": "400",
  "message": "dateOfBirth field missing or empty"
}