Mobile Number Three Elements Verification API Integration Instructions

This article will introduce a Mobile Number Three Elements Verification API integration instruction, which can be used to verify the authenticity and consistency of mobile numbers, names, and ID card numbers.

Application Process

To use the Mobile Number Three Elements Verification API, first go to the 辰汐ai Console to obtain your API Token for future use.

If you are not logged in or registered, you will be automatically redirected to the login page inviting you to register and log in, and after completion, you will be automatically returned to the current page.

One API Token can call all services on the platform without needing to apply separately for each service. The first application will grant a free quota for a trial experience; when the quota is insufficient, you can recharge the general balance in the console.

📘 Complete documentation: Mobile Number Three Elements Verification API →

Basic Usage

First, understand the basic usage method, which is to input the mobile number to obtain the processed result. You need to simply pass a phone field. We can then fill in the corresponding content on the interface, as shown in the figure:

Here we can see that we have set the Request Headers, including:

  • accept: the format of the response result you want to receive, filled in as application/json, which is JSON format.
  • authorization: the key to call the API, which can be selected directly after application.

Additionally, the Request Body is set, including:

  • name: the user's name to be processed, which is a required parameter.
  • phone: the mobile number to be processed, which is a required parameter.
  • id_card: the user's ID card number to be processed, which is a required parameter.
  • verify_mode: verification mode (long version/short version).
  • encrypt_list/ciphertext_blob/iv: optional encryption parameters to encrypt sensitive fields as needed.

After selection, you can find that the corresponding code is also generated on the right side, as shown in the figure:

Click the "Try" button to conduct a test, as shown in the above figure, and we obtained the following result:

{
  "result": "0",
  "description": "Authentication passed",
  "isp": "Mobile",
  "result_detail": null
}

The returned result contains multiple fields, described as follows:

  • result, the authentication result code, with the following charging situation.
    • Charging result codes:
      • 0: Verification result is consistent
      • 1: Verification result is inconsistent
    • Non-charging result codes:
      • -1: No record found
      • -2: Engine unknown error
      • -3: Engine service exception
      • -4: Name verification failed
      • -5: Mobile number is invalid
      • -6: Authentication attempts exceeded the daily limit, please try again the next day
  • description, business result description.

It can be seen that the authenticity and consistency information of the mobile number, name, and ID card number has been queried.

Additionally, if you want to generate the corresponding integration code, you can directly copy it, for example, the CURL code is as follows:

curl -X POST 'https://api.acedata.cloud/identity/phone/check-3e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "phone": "***",
  "id_card": "***"
}'

The integration code in Python is as follows:

import requests

url = "https://api.acedata.cloud/identity/phone/check-3e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "phone": "***",
    "id_card": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Error Handling

When calling the API, if an error occurs, the API will return the corresponding error code and message. For example:

  • 400 token_mismatched: Bad request, possibly due to missing or invalid parameters.
  • 400 api_not_implemented: Bad request, possibly due to missing or invalid parameters.
  • 401 invalid_token: Unauthorized, invalid or missing authorization token.
  • 429 too_many_requests: Too many requests, you have exceeded the rate limit.
  • 500 api_error: Internal server error, something went wrong on the server.

Error Response Example

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Conclusion

Through this document, you have learned how to use the Mobile Number Three Elements Verification API to verify the authenticity and consistency of mobile numbers, names, and ID card numbers. We hope this document can help you better integrate and use this API. If you have any questions, please feel free to contact our technical support team.