# 小程序认证

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:secwxaapi_wxaauth

小程序认证。

服务商代认证小程序介绍

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/sec/wxaauth?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:18

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
auth_dataobject认证数据

# Body.auth_data Object Payload

认证数据

参数名类型必填说明
customer_typenumber企业为1,个体工商户 为12,个人是15,详情参考:获取基本信息接口
taskidstring认证任务id,打回重审调用reauth时为必填
contact_infoobject联系人信息
invoice_infoobject发票信息,如果是服务商代缴模式,不需要改参数
qualificationstring非个人类型必填。主体资质材料 media_id 支持jpg,jpeg .bmp.gif .png格式,仅支持一张图片
qualification_otherarray主体资质其他证明材料 media_id 支持jpg,jpeg .bmp.gif .png格式,最多上传10张图片
account_namestring小程序账号名称
account_name_typenumber小程序账号名称命名类型 1:基于自选词汇命名 2:基于商标命名
account_supplementalarray名称命中关键词-补充材料 media_id 支持jpg,jpeg .bmp.gif .png格式,支持上传多张图片
pay_typenumber支付方式 1:消耗服务商预购包 2:小程序开发者自行支付
auth_identificationstring认证类型为个人类型时可以选择要认证的身份,从查询个人认证身份选项列表里获取,填叶节点的name
auth_ident_materialarray填了auth_identification则必填。身份证明材料 media_id (1)基于不同认证身份上传不同的材料;(2)认证类型=1时选填,支持上传10张图片(3)支持jpg,jpeg .bmp.gif .png格式
third_party_phonestring第三方联系电话
service_appidstring选择服务商代缴模式时必填。服务市场appid,该服务市场账号主体必须与服务商账号主体一致

# Body.auth_data.contact_info Object Payload

联系人信息

参数名类型必填说明
namestring认证联系人姓名
emailstring认证联系人邮箱
mobilestring认证联系人手机号,仅打回重填时可填写

# Body.auth_data.invoice_info Object Payload

发票信息,如果是服务商代缴模式,不需要改参数

参数名类型必填说明
invoice_typenumber发票类型 1: 不开发票 2: 电子发票 3: ~~增值税专票~~(2024年4月3日起废弃) 4: 增值税专票(数电类型)
electronicobject发票类型=2时必填 电子发票开票信息
vatobject发票类型=4时必填 增值税专票(数电类型)开票信息

# Body.auth_data.invoice_info.electronic Object Payload

发票类型=2时必填 电子发票开票信息

参数名类型必填说明
idstring纳税识别号(15位、17、18或20位)
descstring发票备注(选填)

# Body.auth_data.invoice_info.vat Object Payload

发票类型=4时必填 增值税专票(数电类型)开票信息

参数名类型必填说明
enterprise_phonestring企业电话
idstring纳税识别号(15位、17、18或20位)
enterprise_addressstring企业注册地址
bank_namestring企业开户银行(选填)
bank_accountstring企业银行账号(选填)
descstring发票备注(选填)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
taskidstring认证任务id
auth_urlstring小程序管理员授权链接

# 4. 注意事项

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(选填)。具体含义见接口参数说明。

# 其他说明

认证流程的主要节点有事件推送到第三方平台的授权事件接收接口,认证审核状态变化时也会有事件推送。包括任务创建成功、人脸核验通过、短信核验通过、支付完成、派单给审核机构、审核打回、审核通过、审核失败等。

# 事件参数

属性 类型 说明
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>

# 5. 代码示例

请求示例

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": ""
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
0okok
40064invalid app type
43002require POST method需要 POST 请求
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位

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。