获取核身结果
更新时间:2024.11.18按商户拉起核身时预下单的单号获取该次微工卡核身的结果
接口说明
支持商户:【普通服务商】
请求方式:【GET】/v3/payroll-card/authentications/{authenticate_number}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
authenticate_number 必填 string(64)
【商家核身单号】商户系统内部的商家核身单号,要求此参数只能由数字、大小写字母组成,在服务商内部唯一
query 查询参数
sub_mchid 必填 string(32)
【特约商户号】特约商户号
请求示例
GET
应答参数
|
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
: 签约类型
应答示例
200 OK
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统错误 | 5开头的状态码都为系统问题,请使用相同参数 稍后重新调用 |