查询核身记录

更新时间:2024.11.18

查询指定用户指定日期微工卡核身记录,查询结果仅展示核身成功的记录

接口说明

支持商户:【普通服务商】

请求方式:【GET】/v3/payroll-card/authentications

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


query 查询参数

openid  必填 string(64)

【用户OpenID】微信用户OpenID


appid  选填 string(32)

【服务商AppID】当输入服务商AppID时会校验其与服务商商户号绑定关系。
服务商AppID和特约商户AppID至少输入一个。


sub_appid  选填 string(32)

【特约商户AppID】当输入特约商户AppID时会校验其与特约商户号关系。
特约商户AppID和服务商AppID至少输入一个。


sub_mchid  必填 string(32)

【特约商户号】特约商户号


authenticate_date  必填 string(10)

【核身日期】核身日期,一次只能查询一天,最久可查询90天内的记录,格式为“yyyy-MM-DD”


authenticate_state  选填 string(32)

【核身状态】核身状态,列表查询仅提供成功状态的核身记录查询,故此字段固定默认值即可


offset  选填 integer

【本次查询偏移量】非负整数,表示该次请求资源的起始位置,从0开始计数。调用方选填,默认为0。offset为10,limit为10时,查询第10-19条数据


limit  选填 integer

【本次请求最大查询条数】非0非负的整数,该次请求可返回的最大资源条数,默认值为10,最大支持10条。

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/payroll-card/authentications?openid=onqOjjmo8wmTOOtSKwXtGjg9Gb58&appid=wxa1111111&sub_appid=wxa1111111&sub_mchid=1111111&authenticate_date=2020-12-25&authenticate_state=AUTHENTICATE_SUCCESS&offset=0&limit=10 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数
折叠全部参数

200 OK

data  选填 array[object]

【查询结果记录列表】查询结果记录列表

属性

mchid  必填 string(32)

【服务商商户号】服务商商户号


sub_mchid  必填 string(32)

【特约商户商户号】特约商户商户号


openid  必填 string(64)

【用户OpenID】用户OpenID


authenticate_scene  必填 string

【核身渠道】核身渠道,发起核身时的来源渠道,如通过小程序,硬件设备等

可选取值:

  • FROM_MINI_APP: 核身场景来源于小程序

  • FROM_HARDWARE: 核身场景来源于硬件设备


authenticate_source  必填 string(64)

【核身渠道标识】核身渠道标识,用于定位渠道具体来源,如果是扫码打卡渠道标识就是具体的小程序AppID,若是硬件设备,则是设备的序列号等


project_name  必填 string(128)

【项目名称】项目名称


employer_name  必填 string(128)

【用工企业】该工人所属的用工企业,由商户核身下单时传入


authenticate_state  必填 string

【核身状态】核身状态

可选取值:

  • AUTHENTICATE_PROCESSING: 正在进行核身中

  • AUTHENTICATE_SUCCESS: 核身已经成功

  • AUTHENTICATE_FAILED: 核身已经失败


authenticate_time  选填 string(32)

【核身时间】核身时间,遵循RFC3339标准格式,格式为yyyy-MM-DDThh:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。


authenticate_number  必填 string(64)

【商家核身单号】商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一


authenticate_failed_reason  选填 string(128)

【核身失败原因】结果为核身失败时的原因描述,仅在失败记录返回


authenticate_type  选填 string

【核身类型】核身类型

可选取值:

  • NORMAL: 普通核身类型,可用于用户注册认证等

  • SIGN_IN: 签到打卡类型,需要传项目信息

  • INSURANCE: 投保类型

  • CONTRACT: 签约类型


total_count  必填 integer

【总记录条数】经过条件筛选,查询到的记录总数


offset  必填 integer

【记录起始位置】该次请求资源的起始位置,请求中包含偏移量时应答消息返回相同偏移量,否则返回默认值0


limit  必填 integer

【本次返回条数】经过条件筛选,本次查询到的记录条数

应答示例

200 OK

1{
2  "data" : [
3    {
4      "mchid" : "1111111",
5      "sub_mchid" : "111111",
6      "openid" : "onqOjjmo8wmTOOtSKwXtGjg9Gb58",
7      "authenticate_scene" : "FROM_MINI_APP",
8      "authenticate_source" : "wdiooewl7587443649000",
9      "project_name" : "某项目",
10      "employer_name" : "某用工企业",
11      "authenticate_state" : "AUTHENTICATE_PROCESSING",
12      "authenticate_time" : "2015-05-20T13:29:35+08:00",
13      "authenticate_number" : "mcdhehfgisdhfjghed39384564i83",
14      "authenticate_failed_reason" : "人脸验证未通过",
15      "authenticate_type" : "NORMAL"
16    }
17  ],
18  "total_count" : 9,
19  "offset" : 0,
20  "limit" : 10
21}
22

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

500

SYSTEM_ERROR

系统错误

5开头的状态码都为系统问题,请使用相同参数 稍后重新调用

 

 

元宝AI
反馈
目录
置顶