Simplified 3-element verification for phone number-ID Verification(ID Verification)-阿里云帮助中心

This topic describes the simplified 3-element verification for phone number API.

API information

Important

Before calling this API, read the integration process and activate the service.

API name: Mobile3MetaSimpleVerify
Description: Verifies the authenticity and consistency of a phone number, name, and ID card number against authoritative data sources.
QPS limit: This API has a dedicated QPS limit. For more information, see QPS limits for information verification APIs.

Endpoints (the endpoint to use when calling the API):

Region	IPv4	IPv6
common	cloudauth.aliyuncs.com	cloudauth-dualstack.aliyuncs.com
China (Beijing)	cloudauth.cn-beijing.aliyuncs.com	cloudauth-dualstack.cn-beijing.aliyuncs.com
China (Shanghai)	cloudauth.cn-shanghai.aliyuncs.com	cloudauth-dualstack.cn-shanghai.aliyuncs.com

Note

To reduce latency, select an endpoint that is geographically close to your servers.
You can also create a list of endpoints and poll them in rotation to improve availability.

Important

The Information Verification Service does not support a hard cap on call volume or automatic deactivation. To control costs and prevent high bills, configure spending alert rules after you integrate the service:

Configure spending alerts: Set a spending alert rule (Set high-spending alerts) to monitor your bills in real time.
Monitor data transfer plan balance: If you purchased a data transfer plan, also monitor its balance (Configure remaining quota alerts) to add resources or adjust your call policy promptly.

Request parameters

Parameter	Type	Required	Description	Example
ParamType	String	Yes	The encryption method. Valid values: normal: Parameters are sent in plaintext. md5: Parameters are encrypted using MD5. Important The ciphertext for all parameters must be a 32-bit lowercase MD5 string. If an API call succeeds without encryption but fails with it, try using a different MD5 tool. sm2: Parameters are encrypted using SM2. Important For details on SM2 parameter encryption, see Parameter encryption reference.	normal
IdentifyNum	String	Yes	The ID card number. Note Only ID numbers from Resident Identity Card and Residence Permit for Hong Kong, Macao, and Taiwan residents are supported. If ParamType is set to normal, pass the ID card number in plaintext. If ParamType is set to md5, pass the MD5-encrypted ciphertext of the ID card number.	Plaintext: 429001********8211 Ciphertext: 32fa7bcd874161bea8ec8fd98f390ec9
UserName	String	Yes	The name. If ParamType is set to normal, pass the name in plaintext. If ParamType is set to md5, pass the MD5-encrypted ciphertext of the name.	Plaintext: Zhang San Ciphertext: 32fa7bcd874161bea8ec8fd98f390ec9
Mobile	String	Yes	The phone number. If ParamType is set to normal, pass the phone number in plaintext. If ParamType is set to md5, pass the MD5-encrypted ciphertext of the phone number.	Plaintext: 186****2055 Ciphertext: 849169cd3b20621c1c78bd61a11a4fc2

Response parameters

Parameter		Type	Description	Example
RequestId		String	The request ID.	130A2C10-B9EE-4D84-88E3-5384FF039795
Message		String	The response message.	success
Code		String	The response code. A value of 200 indicates success. Other values indicate failure. Important This parameter indicates whether the API call was successful. For detailed descriptions of the return codes, refer to server-side error codes. To see the business verification result, check the fields in ResultObject.	200
ResultObject	BizCode	String	The verification result code. Valid values: 1: The provided information is consistent. 2: The provided information is inconsistent. 3: No record found.	1
ResultObject	IspName	String	The carrier name. Valid values: CMCC: China Mobile CUCC: China Unicom CTCC: China Telecom CBCC: China Broadnet	CMCC

SDK call examples

Important

Before you integrate, read the integration process, activate the service, and get an AccessKey and configure the environment variables.

Get SDK samples and installation packages:

On the online API debugging page in OpenAPI, find the SDK sample code on the right. Click SDK installation information in the upper-right corner of the code sample to view installation details.
Note
Select the required programming language.
For offline installation, go to the SDK installation page, select the SDK for your programming language, and download it from the publishing address.

OpenAPI Explorer: Debug the API online and obtain SDK examples.
Code sample project: Provides sample integration projects for various programming languages.