ThreeElementsVerification-阿里云帮助中心

Verifies the consistency of three user-provided elements: name, mobile phone number, and national ID number. This check confirms that all three pieces of information belong to the same individual.

Operation description

Before using this API, review the pricing for Cell Phone Number Service.
Before using this API, log on to the Cell Phone Number Service console. On the Tag Marketplace page, locate the relevant tag, click Apply, and submit your application materials. After your application is approved, you can use the API.
You are charged for a call only when the API returns Code='OK' and IsConsistent != 2. You are not charged for any other responses.
Numbers from mobile virtual network operators (MVNOs), such as numbers that start with 170, 171, 162, or 165, cannot be verified.

QPS limit

This API has a per-user limit of 200 queries per second (QPS). If you exceed this limit, rate limiting is triggered, which may affect your service. To prevent service disruptions, ensure that your API calls are within this limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dytns:ThreeElementsVerification

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AuthCode	string	Yes	The authorization code. Note In the Cell Phone Number Service console, go to the My Applications page to obtain the authorization ID. This ID serves as the authorization code.	QASDW@#**
InputNumber	string	Yes	The phone number to verify. If Mask is set to NORMAL, provide the number in plaintext. If Mask is set to MD5, provide the MD5-encrypted number. If Mask is set to SHA256, provide the SHA256-encrypted number. Important Encrypted strings are not case-sensitive.	1390000****
Mask	string	Yes	The encryption method. Valid values: NORMAL: No encryption is used. MD5 SHA256	MD5
CertCode	string	Yes	The national ID number to verify. If Mask is set to NORMAL, provide the ID number in plaintext. If Mask is set to MD5, provide the MD5-encrypted ID number. If Mask is set to SHA256, provide the SHA256-encrypted ID number. Important Encrypted strings are not case-sensitive.	83d8040d3cb2181e04****dc6ff5566d4493876a4a5da782887446356b0a787e
Name	string	Yes	The name to verify. If Mask is set to NORMAL, provide the name in plaintext. If Mask is set to MD5, provide the MD5-encrypted name. If Mask is set to SHA256, provide the SHA256-encrypted name. Important Encrypted strings are not case-sensitive.	阿里云

Response elements

Element

Type

Description

Example

object

Code

string

The status code of the request.

OK: The request was successful.
For information about other error codes, see the "Error codes" section of this topic.
RequestFrequencyLimit: The carrier limits the query frequency for the same number. If this error occurs, wait for a period of time before you try again.

Message

string

The description of the status code.

RequestId

string

The ID of the request.

CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

Data

object

The returned data.

BasicCarrier

string

The basic carrier. Valid values:

China Mobile
China Unicom
China Telecom

中国移动

IsConsistent

integer

Indicates whether the verification result is consistent. Valid values:

1: Consistent
0: Inconsistent
2: Not found

Note

Data updates may be delayed by one to three days (T+1 to T+3), depending on the carrier and city. Verification results differ by carrier and mobile number status as follows:

Carrier/Mobile number status	Suspended	Nonexistent number	Canceled
China Mobile	Verified normally	Not found	Not found
China Unicom	Verified normally	Inconsistent	Inconsistent
China Telecom	Verified normally	Not found	Not found

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Data": {
    "BasicCarrier": "中国移动",
    "IsConsistent": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
200	OperatorLimit	The number is limited by the operator.	This mobile phone number is restricted by the carrier.
400	MobileNumberIllegal	Wrong format of phone number
400	EncyrptTypeIllegal	The encryption type of the mobile phone number is illegal
400	CarrierIllegal	Illegal carrier type
400	CertCodeIllegal	Invalid CertCode value.
400	MobileNumberTypeNotMatch	The number and number type do not match.
400	AuthCodeNotExist	The label application form does not exist, please replace the authorization code.
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	Unknown	Unknown error
500	SystemError	System error
500	RequestTimeout	Request supplier timed out.	Request supplier timeout
500	RequestSupplierError	Request supplier error.	Request supplier error.

See for a complete list.

Release notes

See Release Notes for a complete list.