开发者

POST/v3/create_supporting_document

附加辅助证明文件

将基于模板上传的辅助证明文件关联到身份记录。

本页
  1. 附加基于模板的辅助证明文件
  2. 创建辅助证明文件
  3. 已创建的辅助证明文件
  4. 错误与重试

附加基于模板的辅助证明文件

使用以下接口提供的模板:get_supporting_document_templates,并使用已归属您账户的身份记录。通过以下接口上传相关文件:create_encrypt_files,使用的字段为 supporting_template_id。普通身份或地址证明上传属于另一类别,不能用来替代这些上传。

创建辅助证明文件

使用已启用的 MultiTEL API 账户及该账户获准使用的 IP 地址。示例使用环境变量中的 HTTP Basic 身份验证凭据;请遵循您的账户类型所适用的身份验证约定。通过 HTTPS 发送请求。请同时检查 HTTP 响应以及 JSON 中的 status.code;即使返回 HTTP 200,也可能存在应用程序错误。以下示例均为虚构。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document
{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}
请求字段
字段含义
identity_id必填,与您账户关联的身份记录标识符。此请求将文件附加到身份记录,而非直接附加到地址或电话号码。
template_id必填,辅助证明文件模板的标识符;必须使用与上传辅助证明文件时所选相同的模板。附加文件时使用的字段是 template_id,上传时使用的字段则是 supporting_template_id。
encrypted_file_ids必填,由上传后返回的上传标识符组成的非空 JSON 数组。每个上传项都必须属于当前账户、尚未过期,且类别为 supporting_documents。

也接受包含重复 encrypted_file_ids[] 字段的表单数据。请勿向此附加文件端点发送文件字节。

已创建的辅助证明文件

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

这仅确认辅助证明文件已创建,并不表示已获监管批准或号码已激活。上游资源中的“永久”一词不构成面向客户的存储期限或删除政策保证。

错误与重试

API 代码 500 表示缺少输入、运营商错误或运营商响应无效。代码 404 表示身份记录未与账户关联、模板无效、上传项缺失、已过期或类别错误,或者可用文件集合为空。请检查 status.msg;仅凭 HTTP 200 不足以判断结果。

请在返回的文件引用有效期内完成上传和附加。如果响应未能明确结果,请先在门户中检查该身份记录的辅助证明文件,再重试。此处理程序不提供幂等键。