Domain name for API request: faceid.intl.tencentcloudapi.com.
Obtain document NFC data, input the Token returned by the NFC SDK (valid for 10 minutes), and return the corresponding document information retrieved via NFC. This API supports NFC recognition and verification of ID cards (second-generation resident identity card, Residence Permit for Hong Kong (China) and Macao (China), Residence Permit for Taiwan (China), Permanent Residence Permit for Foreigners) as well as travel documents (exit-entry permit for travelling to and from Hong Kong (China) and Macao (China), Taiwan travel permit, Mainland Travel Permit for Taiwan Residents, Return Home Permit).
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: GetWxNFCResult. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-01. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| NFCToken | Yes | String | Unique identifier ID returned by the frontend NFC SDK |
| Parameter Name | Type | Description |
|---|---|---|
| ResultCode | String | NFC billing result code. Each successful NFC read is billed once (duplicate billing does not occur for repeated pull of the same NFC request). Permissible range of billing result codes: |
| IdNum | String | Identity card number Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | name Note: This field may return null, indicating that no valid values can be obtained. |
| Picture | String | Portrait photo in the document Note: This field may return null, indicating that no valid values can be obtained. |
| IdCardFrontImg | String | Front photo of the identity document (portrait side) Note: This field may return null, indicating that no valid values can be obtained. |
| IdCardBackImg | String | Photo of the back of an identity document (national emblem side) Note: This field may return null, indicating that no valid values can be obtained. |
| BirthDate | String | Date of birth Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | Validity start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | Validity end time Note: This field may return null, indicating that no valid values can be obtained. |
| Address | String | Address Note: This field may return null, indicating that no valid values can be obtained. |
| Nation | String | Ethnicity Note: This field may return null, indicating that no valid values can be obtained. |
| Sex | String | Gender Note: This field may return null, indicating that no valid values can be obtained. |
| IdType | String | Document type Enumeration value:
Note: This field may return null, indicating that no valid values can be obtained. |
| EnName | String | English name Note: This field may return null, indicating that no valid values can be obtained. |
| SigningOrganization | String | Issuing authority Note: This field may return null, indicating that no valid values can be obtained. |
| OtherIdNum | String | Residence Permit for residents of Hong Kong (China), Macao (China) and Taiwan (China), passport number Note: This field may return null, indicating that no valid values can be obtained. |
| Nationality | String | Travel document nationality Note: This field may return null, indicating that no valid values can be obtained. |
| PersonalNumber | String | Characters 29 to 42 in the second line of the machine-readable zone of the travel document Note: This field may return null, indicating that no valid values can be obtained. |
| CheckMRTD | String | Verification result of the document
Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWxNFCResult
<Common request parameters>
{
"NFCToken": "d102c9c8-5423-11f1-97f9-52540044344e"
}
{
"Response": {
"Address": "Room ***, Unit *, Building *, **** District, ** City, Fujian Province",
"BeginTime": "",
"BirthDate": "",
"CheckMRTD": "",
"EnName": "ZHAN***ZHEN",
"EndTime": "",
"IdCardBackImg": "",
"IdCardFrontImg": "",
"IdNum": "350481***111140011",
"IdType": "",
"Name": "Zhang*",
"Nation": "",
"Nationality": "",
"OtherIdNum": "",
"PersonalNumber": "",
"Picture": "",
"ResultCode": "-1",
"Sex": "",
"SigningOrganization": "Yongan ***"
"RequestId": "096513c7-1ee5-4620-a36b-9f5101cd2737"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidTokenParameter | Token not found |
| InternalError | Internal error. |
| InternalError.UnKnown | Unknown internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Incorrect parameter value. |
文档反馈