用于验证用户姓名、手机号和身份证号是否一致的API。
接口说明
请求说明
本接口仅支持虚商号码,即手机号必须以 170、171、165、162、167 开头。
当且仅当返回值中 Code='OK' 且 IsConsistent != 0 时计费。
使用前需在号码百科控制台申请开通对应标签,并获取授权码。
目前加密方式仅支持不加密(NORMAL)。
单用户 QPS 限制为 100 次/秒,超过将被限流。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AuthCode |
string |
是 |
授权码。说明:在号码百科控制台 我的申请 页面,获取授权 ID 即授权码。 |
XXXXXX |
| InputNumber |
string |
是 |
待查询的号码。
|
175XXXX6789 |
| Mask |
string |
是 |
加密方式。取值:
|
NROAML |
| CertName |
string |
是 |
待核验的姓名。 |
XX |
| CertCode |
string |
是 |
待核验的身份证号。
|
身份证号 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|
||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
- |
| RequestId |
string |
请求 ID。 |
CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47 |
| Message |
string |
状态码的描述。 |
OK |
| Data |
object |
结构体。 |
|
| IsConsistent |
integer |
验证结果是否一致。返回:
|
0 |
| Code |
string |
请求状态码。
|
OK |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "-",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Message": "OK",
"Data": {
"IsConsistent": 0
},
"Code": "OK"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | AuthCodeIllegal | Illegal authCode. | 鉴权时使用的authcode不可用于该接口 |
| 400 | AuthCodeAndApiNotMatch | AuchCode和请求的Api不匹配 | AuchCode和请求的Api不匹配 |
| 400 | InvalidParameter | Invalid parameter. | 无效参数 |
| 400 | OperatorLimit | Number is limited by the operator. | 运营商禁止查询的号码 |
| 400 | MobileNumberNotSupported | Mobile number is not supported. Only virtual carrier numbers (170/171/165/162/167) are accepted. | 本接口只支持170/171/165/162/167号段的虚商号码查询 |
| 500 | SupplierTimeout | Request vendor timeout. | 请求供应商超时 |
| 500 | RequsetTimeout | Request supplier timed out. | 请求供应商超时 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。