手机号码三要素验证 API 集成指南

5 阅读3分钟

在当今数字化时代,确保用户信息的真实性与一致性变得尤为重要。Ace Data Cloud 提供的手机号码三要素验证 API,能够有效验证手机号码、姓名及身份证号码的真实性,帮助企业提升信息安全性。本文将详细介绍该 API 的集成步骤及使用场景。

申请流程

要使用手机号码三要素验证 API,首先需要在 Mobile Number Three Elements Verification API 页面申请相应服务。进入页面后,点击“获取”按钮,如下图所示:

如果您尚未登录或注册,系统会自动引导您到登录页面。完成登录或注册后,您将自动返回当前页面。

首次申请时,系统会授予您一定的免费配额,使您可以免费使用该 API。

基本用法

使用 API 的基本方法是输入手机号码以获取处理结果。您只需传递一个 phone 字段。可以在界面上填写相应内容,如下图所示:

在此界面中,我们设置了请求头,包括:

  • accept:期望接收的响应结果格式,填写为 application/json,表示以 JSON 格式返回。
  • authorization:调用 API 的密钥,申请后可直接选择。

接下来设置请求体,包括:

  • name:待处理的用户姓名,必填参数。
  • phone:待处理的手机号码,必填参数。
  • id_card:待处理的身份证号码,必填参数。
  • verify_mode:验证模式(长版/短版)。
  • encrypt_list / ciphertext_blob / iv:可选的加密参数,用于加密敏感字段。

填写完毕后,系统会在右侧生成对应的代码,如下图所示:

点击“尝试”按钮进行测试,您将获得如下结果:

{
  "result": "0",
  "description": "认证通过",
  "isp": "移动",
  "result_detail": null
}

返回结果包含多个字段,具体描述如下:

  • result:认证结果代码,收费情况如下:
    • 收费结果代码:
      • 0:验证结果一致
      • 1:验证结果不一致
    • 非收费结果代码:
      • -1:未找到记录
      • -2:未知引擎错误
      • -3:引擎服务异常
      • -4:姓名验证失败
      • -5:手机号码无效
      • -6:认证尝试超过每日限制,请明天再试
  • description:业务结果描述。

通过查询,您可以获得手机号码、姓名和身份证号码的真实性和一致性信息。

如果您希望生成相应的集成代码,可以直接复制。例如,CURL 代码如下:

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": "***"
}'

Python 集成代码如下:

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)

错误处理

在调用 API 时,如果发生错误,API 将返回相应的错误代码和消息。例如:

  • 400 token_mismatched:错误请求,可能是由于缺少或无效参数。
  • 400 api_not_implemented:错误请求,可能是由于缺少或无效参数。
  • 401 invalid_token:未授权,授权令牌无效或缺失。
  • 429 too_many_requests:请求过多,超过速率限制。
  • 500 api_error:内部服务器错误,服务器出现问题。

错误响应示例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "获取失败"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

总结

通过本文,您已经学习了如何使用手机号码三要素验证 API 来验证手机号码、姓名和身份证号码的真实性与一致性。这一工具不仅能够提升业务的安全性,更能帮助企业构建可信赖的用户信息管理体系。如有任何问题,请随时联系技术支持团队。

标签:#API #安全 #数据验证 #AceDataCloud #开发者工具