Skip to main content
This document will introduce an Identity Information and Validity Verification API integration instruction, which can be used to verify the authenticity and consistency of names, ID card numbers, and ID card validity periods.

​
Application Process

To use the API, you need to first apply for the corresponding service on the Identity Information and Validity Verification API page. After entering the page, click the “Acquire” button, as shown in the image below: If you are not logged in or registered, you will be automatically redirected to the login page inviting you to register and log in. After logging in or registering, you will be automatically returned to the current page. There will be a free quota granted for the first application, allowing you to use the API for free.

​
Basic Usage

First, understand the basic usage method, which is to input the ID card image link to obtain the processed verification result. You first need to simply pass a name field, and we can then fill in the corresponding content on the interface, as shown in the image below:

Here we can see that we have set the Request Headers, including:
  • accept: the format of the response result you want to receive, here filled as application/json, which means JSON format.
  • authorization: the key to call the API, which can be directly selected from the dropdown after application.
Additionally, the Request Body is set, including:
  • name: name.
  • id_card: ID card number.
  • image_url: link to the face image that needs to be processed.
  • validity_end: expiration date of the ID card, format: YYYYMMDD, use “00000000” for long-term;
  • validity_begin: start date of the ID card validity, format: YYYYMMDD.
  • encryption: optional, sensitive field encryption parameter (if you need to send encrypted data).
After selection, you can find that the corresponding code is also generated on the right side, as shown in the image below:

Click the “Try” button to conduct a test, as shown in the above image, and we obtained the following result: 
{
  "result": "0",
  "description": "Consistent"
}
The returned result contains multiple fields, described as follows:
  • result, the authentication result code, with the following charging situation.
    • Charged result codes:
      • 0: Name and ID card number are consistent
      • -1: Name and ID card number are inconsistent
    • Non-charged result codes:
      • -2: Illegal ID card number (length, check digit, etc. are incorrect)
      • -3: Illegal name (length, format, etc. are incorrect)
      • -4: Document database service exception
      • -5: No record of this ID card in the document database
      • -6: The authoritative comparison system is being upgraded, please try again later
      • -7: The number of authentications has exceeded the daily limit.
  • description, the result of the verification of the name and ID card number here.
It can be seen that the name, ID card number, and ID card validity period in the ID card have authenticity and consistency. 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/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
The integration code in Python is as follows: 
import requests

url = "https://api.acedata.cloud/identity/idcard/check-2e"

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

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

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 Identity Information and Validity Verification API to verify the authenticity and consistency of names, ID card numbers, and ID card validity periods. We hope this document can help you better integrate and use the API. If you have any questions, please feel free to contact our technical support team.