接口说明
姓名、证件号与人脸照片比对,返回核验结果。提交姓名(name,必填)、18 位身份证号码(idcard,必填)、人脸图片 HTTPS 地址(photo,必填)。只返回要素是否一致等比对结果,不提供证件原件。涉及姓名、证件号、银行卡或人脸时,须先取得本人授权。
请求方式
| 请求地址 | https://sowk.xingsuqy.com/v1/query/id-face |
|---|---|
| 请求方法 | POST |
| Content-Type | application/json |
| 鉴权 | 请求头 X-API-Key |
请求参数
| name | type | required | desc |
|---|---|---|---|
| name | string | 是 | 姓名 |
| idcard | string | 是 | 18 位身份证号码 |
| photo | string | 是 | 人脸图片 HTTPS 地址 |
返回参数
data 字段结构如下,外层为统一响应结构(见开发文档)。
| name | type | desc |
|---|---|---|
| result | integer | 1 一致,0 不一致 |
| score | number | 匹配或风险评分 |
| desc | string | 结果说明 |
请求示例
curl -X POST https://sowk.xingsuqy.com/v1/query/id-face \
-H "X-API-Key: xs_your_key" \
-H "Content-Type: application/json" \
-d '{"name":"张*","idcard":"110101********1234","photo":"https://example.com/masked-face.jpg"}'返回示例
以下为文档示例,不是本次实时查询结果。请勿把示例数据作为业务判断依据。
{
"code": 0,
"message": "success",
"request_id": "20260919120000abc123",
"data": {
"result": 1,
"score": 0.95,
"desc": "一致"
}
}错误码
| code | HTTP | 说明 | 处理建议 |
|---|---|---|---|
| 0 | 200 | 成功 | — |
| 400 | 400 | 参数缺失或格式错误 | 检查 message 指出的参数 |
| 401 | 401 | API Key 缺失或无效 | 在控制台核对 Key |
| 1002 | 402 | 该接口无可用次数 | 联系客服开通 |
| 1003 | 403 | 该接口未对当前账户开通 | 联系客服开通 |
| 404 | 404 | 接口不存在 | 核对接口编号 |
| 429 | 429 | 超出频率限制 | 按 Retry-After 重试 |
计费说明
本页为接口参考报价。具体套餐、计费口径与开通范围请在申请时确认;提交申请不会扣费。
连接检查
可先检查本站网关是否可达。此检查不查询业务数据、不需要 API Key,也不代表已取得当前接口权限。
curl https://sowk.xingsuqy.com/v1/status
收到 code=0、service=xingsu 表示网关响应正常;正式查询请按上面的请求参数,在服务端使用自己的 API Key。