# 小程序认证
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
secwxaapi_wxaauth
# 功能描述
小程序认证
# 注意事项
1、认证任务创建后需要在24小时内完成授权与支付,过期后需要重新创建任务
2、如果授权任务已经到达支付页面,为了避免临界情况支付完成事件延迟,该小程序在6小时内不能重新创建认证任务,即使上个任务已经超过24小时 3、任务的授权与支付过程关注task_status的变化,task_status的值参考queryauth接口的定义 4、任务授权与支付完成后会创建审核单,此时关注回调事件中apply_status的变化,apply_status的值参考queryauth接口的定义 5、根据《国家税务总局深圳市税务局关于开展全面数字化的电子发票试点工作的公告》的管理要求,2024年5月15日起,平台将不再支持开具增值税专票(纸质类型),对应统一调整为增值税专票(数电类型)。调整后将无法提交纸质增值税专票开票申请,请开发者提前进行接口适配并做好用户指引(注:在此时间节点前提交的纸质增值税专票开票申请不受影响)。查看数电发票说明 字段变更说明: 发票类型invoice_type新增枚举值4,表示增值税专票(数电类型) 当invoice_type=4时,发票参数需填写:id(必填)、enterprise_phone(必填)、enterprise_address(必填)、desc(选填)、bank_name(选填)、bank_account(选填)。具体含义见接口参数说明。# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/sec/wxaauth?access_token=TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:18
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用authorizer_access_token | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
auth_data | object | 是 | 认证数据 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
taskid | string | 认证任务id |
auth_url | string | 小程序管理员授权链接 |
# 其他说明
认证流程的主要节点有事件推送到第三方平台的授权事件接收接口,认证审核状态变化时也会有事件推送。包括任务创建成功、人脸核验通过、短信核验通过、支付完成、派单给审核机构、审核打回、审核通过、审核失败等。
# 事件参数
属性 | 类型 | 说明 |
---|---|---|
InfoType | string | 消息类型,固定为 notify_3rd_wxa_auth |
appid | string | 小程序appid |
task_status | number | 状态码,见各API返回码。当task_status为0, 6, 9, 12时有事件通知 |
apply_status | numnber | 审核单状态,当apply_status变为2、3、4、5时会有事件通知 |
dispatch_info.provider | string | 审核机构名称(当apply_status=2时有效) |
dispatch_info.contact | string | 审核机构联系方式(当apply_status=2时有效) |
dispatch_info.dispatch_time | number | 派单时间戳(秒)(当apply_status=2时有效) |
message | string | 提示信息 |
创建认证任务成功的事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700634212</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>0</task_status>
<message><![CDATA[资料检验成功,等待管理员授权]]></message>
<taskid><![CDATA[048ae3f93e664053baf8cd1e1a899896]]></taskid>
<apply_status>0</apply_status>
</xml>
人脸核验通过事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4e8ad]]></AppId>
<CreateTime>1700619258</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf166189b712d658]]></appid>
<task_status>6</task_status>
<message><![CDATA[人脸核验通过]]></message>
<taskid><![CDATA[faa609b8c4524a19bc9bb6cf9edfa3b5]]></taskid>
<apply_status>0</apply_status>
</xml>
短信通过事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4e8ad]]></AppId>
<CreateTime>1700619277</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf166189b712d658]]></appid>
<task_status>9</task_status>
<message><![CDATA[短信验证通过]]></message>
<taskid><![CDATA[faa609b8c4524a19bc9bb6cf9edfa3b5]]></taskid>
<apply_status>0</apply_status>
</xml>
支付完成的事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700619290</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>12</task_status>
<message><![CDATA[支付完成]]></message>
<taskid><![CDATA[faa609b8c4524a19bc9bb6cf9edfa3b5]]></taskid>
<apply_status>2</apply_status>
</xml>
审核机构派单成功事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700619311</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>12</task_status>
<message><![CDATA[审核派单通知]]></message>
<taskid><![CDATA[faa609b8c4524a19bc9bb6cf9edfa3b5]]></taskid>
<apply_status>2</apply_status>
<dispatch_info>
<provider><![CDATA[上海倍通企业信用征信有限公司(测试)]]></provider>
<contact><![CDATA[热线电话:0086-13249064176,咨询时间:周一至周五(工作日)8:30-17:30。]]></contact>
<dispatch_time>1700619300</dispatch_time>
</dispatch_info>
</xml>
打回重填事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700637974</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>12</task_status>
<message><![CDATA[测试]]></message>
<taskid><![CDATA[048ae3f93e664053baf8cd1e1a899896]]></taskid>
<apply_status>3</apply_status>
</xml>
重新提审提交成功事件
<xml><AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700639140</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>12</task_status>
<message><![CDATA[资料重新提审成功]]></message>
<taskid><![CDATA[048ae3f93e664053baf8cd1e1a899896]]></taskid>
<apply_status>2</apply_status>
</xml>
认证成功事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700624277</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]>
</InfoType><appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>12</task_status>
<message><![CDATA[认证成功]]></message>
<taskid><![CDATA[15086754e2a644d584517ff42057e3b8]]></taskid>
<apply_status>4</apply_status>
</xml>
认证失败事件
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700642375</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_auth]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<task_status>12</task_status>
<message><![CDATA[由于您由于您的申请已经超期,同时未提交xxxxxxx,无法继续申请,本次认证失败。]]></message>
<taskid><![CDATA[048ae3f93e664053baf8cd1e1a899896]]></taskid>
<apply_status>5</apply_status>
</xml>
如需监听小程序认证年审和过期能力限制提醒(过期当天&过期30天&过期60天),可以同时监听以下事件。
# 事件参数
属性 | 类型 | 说明 |
---|---|---|
InfoType | string | 消息类型,固定为 notify_3rd_wxa_wxverify |
appid | string | 小程序appid |
expired | number | 认证过期时间戳(秒) |
message | string | 提醒消息内容 |
到期前提醒示例
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700634212</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_wxverify]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<expired>1704162245</expired>
<message><![CDATA[账号名称: 我的小程序名
到期时间: 2024年1月2日
详情: 账号已进入年审期,为确保运营主体经营状态存续、命名合规、行业资质真实有效且线上服务可用,请尽快完成认证年审。 到期未完成年审将影响新版本发布和“被搜索”能力。逾期 30 天将影响“被分享”能力,逾期 60 天将影响新用户访问及支付功能。]]></message>
</xml>
认证过期30天提醒示例
<xml>
<AppId><![CDATA[wx31f828cesdfa4eabc]]></AppId>
<CreateTime>1700634212</CreateTime>
<InfoType><![CDATA[notify_3rd_wxa_wxverify]]></InfoType>
<appid><![CDATA[wxaf614423g25ffd9b]]></appid>
<expired>1704162245</expired>
<message><![CDATA[账号名称: 我的小程序名
到期时间: 2024年1月2日
详情: 账号逾期未完成微信认证,将影响新版本发布和“被搜索”能力。如未在2024年2月2日前完成认证将影响“被分享”能力。]]></message>
</xml>
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
https://api.weixin.qq.com/wxa/sec/wxaauth?access_token=TOKEN
{
"auth_data" : {
"account_name" : "",
"account_name_type" : 0,
"account_supplemental" : [ "", "" ],
"auth_ident_material" : [ "", "" ],
"auth_identification" : "",
"customer_type" : 15,
"contact_info" : {
"email" : "认证联系人电子信箱",
"name" : "认证联系人姓名"
},
"invoice_info" : {
"electronic" : {
"desc" : "电子发票信息-发票备注(选填)",
"id" : "电子发票信息-纳税识别号(15位、17、18或20位)"
},
"invoice_type" : 0,
"vat" : {
"enterprise_phone" : "增值税专票-企业电话",
"id" : "增值税专票-纳税识别号(15位、17、18或20位)",
"desc": "发票备注,选填"
}
},
"pay_type" : 0,
"qualification" : "",
"qualification_other" : [ "", "" ],
"service_appid" : "",
"third_party_phone" : ""
}
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "",
"taskid": ""
}
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok | ok |
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
43002 | require POST method | 需要 POST 请求 |
40064 | invalid app type | |
89601 | 帐号状态异常 | 帐号状态异常 |
89602 | 账号主体类型与认证类型不一致 | 账号主体类型与认证类型不一致 |
89603 | 个人类型的发票类型只能选不开发票或电子专票,不支持开增值税专票 | 个人类型的发票类型只能选不开发票或电子专票,不支持开增值税专票 |
89604 | 认证进行中,请勿重复提交 | 认证进行中,请勿重复提交 |
89605 | 认证任务重复,请重试 | 认证任务重复,请重试 |
89608 | 订单审核中或者不是打回重审状态,不能重新提审 | 订单审核中或者不是打回重审状态,不能重新提审 |
89620 | 帐号未完成注册 | 帐号未完成注册 |
89621 | 只允许完成了认证的个人、企业、个体户帐号进行认证 | 只允许完成了认证的个人、企业、个体户帐号进行认证 |
89622 | 只允许完成了认证的个人、企业、个体户帐号进行认证 | 只允许完成了认证的个人、企业、个体户帐号进行认证 |
89623 | 提交的认证类型不正确 | 提交的认证类型不正确 |
89629 | 其它原因 | 其它原因 |
89634 | 认证身份职业无效 | 认证身份职业无效 |
89635 | 发票抬头和认证主体名称不一致 | 发票抬头和认证主体名称不一致 |
89636 | 材料无效 | 材料无效 |
89637 | 查询不到照面信息 | 查询不到照面信息 |
89638 | 昵称检测不通过,格式错误 | 昵称检测不通过,格式错误 |
89639 | 照面信息状态不对,非在营状态 | 照面信息状态不对,非在营状态 |
89640 | 开票类型不正确,比如选了不开票但填写了开票信息 | 开票类型不正确,比如选了不开票但填写了开票信息 |
89641 | 发票信息不正确,除了备注其它都需要填写,纳税人识别号只能是15、17、18、20位 | 发票信息不正确,除了备注其它都需要填写,纳税人识别号只能是15、17、18、20位 |