对信息模板进行实名认证--域名服务-火山引擎

文档中心

导航

对信息模板进行实名认证

最近更新时间：2024.06.26 13:18:24首次发布时间：2023.06.06 22:21:03

API 说明

API 名称：ValidateTemplate
API 域名：open.volcengineapi.com
API 描述：对一个信息模板启动实名认证流程。您可以使用 GetTemplate，在其响应正文的 status 字段中获取实名认证的结果。

请求方法

POST

使用限制

节流限制：您每秒最多可以发送 20 个请求。

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权。

公共参数

在调用该 API 时，您在请求中必须包含公共参数。在这些公共参数中，以下两个查询参数的取值说明如下：

参数名称	数据类型	必选	参数说明
Action	string	是	表示 API 的名称。该参数的取值是 `ValidateTemplate`。
Version	string	是	表示 API 的版本。该参数的取值是 `2022-12-12`。

请求参数

该 API 的请求参数的类型是请求正文参数。

参数名称	数据类型	必选	参数说明	示例
tag	string	是	表示需要实名认证的信息模板的 tag。	`G0zM6RUUWLPysIuVPF7obA==`
id_type	string	是	表示域名所有者提供的证件的类型。证件类型是在"个人"与"企业"这 2 个大类下。该参数有以下取值：个人 `SFZ`：表示身份证。 `HZ`：表示护照。 `TXZ`：表示港澳居民来往内地通行证。 `TWSFZ`：台湾居民来往大陆通行证。 `GWSFZ`：表示外国人永久居留身份证。 `GAJZZ`：表示港澳居民居住证。 `TWJZZ`：表示台湾居民居住证。企业 `ORG`：表示组织机构代码证。 `YYZZ`：表示工商营业执照。 `TYDMZ`：表示统一社会信用代码证书。 `BDDH`：表示部队代号。 `JDXKZ`：表示军队单位对外有偿服务许可证。 `SYZS`：表示事业单位法人证书。 `GWCZDJZ`：表示外国企业常驻代表机构登记。 `STDJZ`：表示社会团体法人登记证书。 `ZJDJZ`：表示宗教活动场所登记证。 `MBDJZ`：表示民办非企业单位登记证书。 `JJDJZ`：表示基金会法人登记证书。 `LSXKZ`：表示律师事务所执业许可证。 `GWZHDJZ`：表示外国在华文化中心登记证。 `GWLYDJZ`：表示外国政府旅游部门常驻代表机构批准登记证。 `SFXKZ`：表示司法鉴定许可证。 `GWJGZJ`：表示外国机构证件。 `SHFWJGZ`：表示社会服务机构登记证书。 `MBXXXKZ`：表示民办学校办学许可证。 `YLJGXKZ`：表示医疗机构执业许可证。 `GZJGZYZ`：表示公证机构执业证。 `BJWSXX`：表示北京市外国驻华使馆人员子女学校办学许可证。 `QTTYDMZ`：表示其他统一社会信用代码证书。	`SFZ`
id_code	string	是	表示 `id_type` 所指示的证件的号码。例如身份证号码、营业执照号码等。	`310115198404191234`
id_img	string	是	表示证件的正面照片转换成的Base64字符串。该照片必须为 JPG 或 JPEG 格式，文件大小在 55KB 与 1MB 之间。

示例

请求示例

POST https://open.volcengineapi.com?Version=2022-12-12&Action=ValidateTemplate
{
    "tag":"G0zM6RUUWLPysIuVPF7obA==",
    "id_type":"SFZ",
    "id_code": "310115198404191234",
    "id_img":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230522152902BF8AE46450333517309F",
        "Action": "ValidateTemplate",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。关于更多错误码的信息，参见错误码。