CompanyTwoElementsVerification
Used to verify the enterprise name and enterprise certificate number. The name and certificate must be fully consistent, and the enterprise must be in operating status for the verification to pass.
Operation description
Before you use this API, make sure that you fully understand the billing methods and pricing of the Enterprise Two-Element Verification product. For billing details, see Product billing.
Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
Before you use this API, log on to the Cell Phone Number Service console, find the corresponding tag on the Tag Plaza page, click Apply to Activate, and fill in the application materials. After the application is approved, you can use the API.
QPS limit
The single-user QPS limit for this API is 200 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the API reasonably.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dytns:CompanyTwoElementsVerification |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| EpCertNo |
string |
Yes |
Enterprise certificate number. |
9242032*******J627 |
| EpCertName |
string |
Yes |
Enterprise name. |
Sample Enterprise |
| AuthCode |
string |
Yes |
Authorization code. Note
Log on to the Cell Phone Number Service console, and obtain the authorization ID (i.e., authorization code) on the My Applications page. |
Dd1r***4id |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| AccessDeniedDetail |
string |
Details about the access denial. |
- |
| RequestId |
string |
The common parameter. Each request returns a unique ID, which can be used to troubleshoot and locate issues. |
68A40250-50CD-034C-B728-0BD135850177 |
| Message |
string |
The description of the returned status code. |
OK |
| Data |
object |
The struct. |
|
| DetailInfo |
object |
Enterprise details. Note
This field is not returned for public institutions or civil groups. |
{ "enterpriseStatus": "Operating (in business)", "openTime": "2023-05-25/2053-05-24" } |
| OpenTime |
string |
The business term of the enterprise. |
2023-05-25/2053-05-24 |
| EnterpriseStatus |
string |
The operating status of the enterprise. |
Operating (in business) |
| InconsistentData |
array |
The fields that are inconsistent in the verification. |
|
|
string |
|
EpCertName |
|
| VerifyResult |
string |
The verification result. Valid values:
Note
The operating status verification is not supported for public institutions or civil groups. Only the consistency between the enterprise name and the enterprise certificate number is verified. |
true |
| ReasonCode |
string |
The verification result code. Valid values:
|
0 |
| Code |
string |
The request status code. |
OK |
Examples
Success response
JSON format
{
"AccessDeniedDetail": "-",
"RequestId": "68A40250-50CD-034C-B728-0BD135850177",
"Message": "OK",
"Data": {
"DetailInfo": {
"OpenTime": "2023-05-25/2053-05-24",
"EnterpriseStatus": "在营(开业)"
},
"InconsistentData": [
"EpCertName"
],
"VerifyResult": "true",
"ReasonCode": "0"
},
"Code": "OK"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | Invalid parameter. | |
| 400 | AuthCodeIllegal | Illegal authCode. | |
| 500 | RequestTimeout | Request supplier timed out. | Request supplier timeout |
| 500 | RequestSupplierError | Request supplier error. | Request supplier error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.