开发者

POST/v3/create_document

创建注册配置文件

创建身份/地址配置文件,并分别保留其配置文件标识符和实体标识符。

本页
  1. 只创建一次配置文件
  2. 创建请求
  3. 保留全部三个标识符
  4. 高级:在创建期间附加预先上传的证明
  5. 失败与部分创建

只创建一次配置文件

此请求会创建一个本地注册配置文件,同时创建运营商身份记录和地址记录。请先查看当前的注册国家/地区、号码类型和要求。要求取决于您计划注册的国家/地区和号码类型。

创建成功的响应并不代表监管批准或号码激活。请分别保存文档 UUID、身份 ID 和地址 ID:它们的用途各不相同。此请求会更改账户数据,并非仅验证操作。

创建请求

使用您已启用的 MultiTEL API 账户及其允许的 IP 地址进行身份验证。示例使用存储在环境变量中的 HTTP Basic 凭据。请同时检查 HTTP 响应和 JSON status.code;仅凭 HTTP 200 响应并不能确认成功。所有示例值均为虚构。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile.json \
  https://api.multitel.net/v3/create_document
{
  "identity_type": "Personal",
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "country": "US",
  "address": "1 Example Street",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}

该 JSON 是一个示例性的 Personal 配置文件,而不是可直接提交的真实身份。请用所选注册规则要求的最终用户信息替换其中的详细信息和签名。也支持表单编码输入。

注册配置文件字段
字段必填项与格式
identity_type必填。请使用精确值 Personal 或 Business;条件验证取决于大小写。
first_name, last_name必填,每项最多 64 个字符。对于企业,请提供所选国家/地区要求的代表人详细信息。
phone_number必填的数字电话值,至少八个字符。包含国家代码的纯数字国际号码适用于此验证;这是联系电话,而不是号码购买。
city, postal_code, address必填,每项最多 64 个字符。
country必填,来自注册目录的地址国家/地区 ISO 代码。服务会将其解析为运营商国家/地区记录。
signature必填的签名数据。当前门户提供不带 data:image/png;base64, 前缀的 Base64 PNG 图像字节。请通过您的授权工作流程获取最终用户签名;非空占位符不是有效签名。
nationalityPersonal 必填,为国家/地区 ISO 代码。请勿用国家/地区 UUID 代替。
company_name, incorporation_countryBusiness 必填。公司名称最多 64 个字符;incorporation_country 为国家/地区 ISO 代码。
email可选的最终用户联系电子邮件,最多 254 个字符。省略或留空的电子邮件不会继承基础账户的电子邮件。
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description在此处理程序中为可选,但所选国家/地区或运营商可能要求其中某些字段。请提供该注册所要求的格式。直接 API 调用不会自动应用门户执行的每一项规范化。

此直接 v3 处理程序要求提供地址字段并会创建一个地址。请勿假设门户的延迟地址选项可通过它使用。

保留全部三个标识符

以下仅显示部分响应字段;实际响应还包含已提交的配置文件信息和签名数据。请将完整响应作为私密数据处理。

{
  "status": {
    "code": 200,
    "msg": "Success Create Registration Detail."
  },
  "response": {
    "uuid": "11111111111111111111111111111111",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "country_iso": "US",
    "email": "end-user@example.com"
  }
}
  • response.uuid 标识本地配置文件。请将其与 get_document 一起使用。在 documents 和 get_document 的响应中,同一个配置文件标识符被命名为 id。
  • response.identity_id 标识后续 身份证明 和 支持文件 所使用的身份。
  • response.address_id 标识已创建的地址。请单独保存;本地配置文件 UUID 不是地址 ID。新创建的配置文件后续附加地址证明的兼容性仍在审查中。

两个配置文件回读端点都不会返回 identity_id 或 address_id,因此请保留最初成功的创建响应。如果该响应已丢失,请在创建替代配置文件之前使用门户文档视图或联系支持团队。

高级:在创建期间附加预先上传的证明

您可以提供 identity_encryptfiles 和 address_encryptfiles 作为由 create_encrypt_files 返回的 ID 数组。请使用与相应实体类别匹配的证明类型上传,然后在大约 20 分钟的文件引用过期之前提交。创建处理程序会检查每个所提供引用的账户、类别和过期情况。

这些字段的名称与后续附件端点的 encrypted_file_ids 不同。在创建期间,每个文件都会作为单独的证明请求发送,即使多个文件共用同一证明类型也是如此。对于必须同时包含多个文件的身份证明,请在之后使用带有一个数组的 create_proof 请求。仅配置文件创建成功本身并不提供各项证明的审批结果。

如果新创建地址的后续地址证明被拒绝,请勿用配置文件 UUID 代替,也不要反复重新创建身份。请停止操作,并在门户中或联系支持团队检查该配置文件。地址证明的回读/查询路径仍是一项审查限制。

失败与部分创建

API 代码 400 涵盖字段验证、运营商创建失败和本地保存失败。验证错误可能以字段键控条目的形式出现在 response 中。代码 500 用于注册国家/地区不可用或无效的情况,代码 404 用于预先上传的引用缺失或已过期的情况。除代码外,还请阅读 status.msg。

本地配置文件操作与上游运营商操作不是一个原子事务。失败的请求可能会留下上游状态,即使没有列出任何本地配置文件。未公开客户端幂等键。在超时或结果不确定的失败之后,请先检查现有配置文件并联系支持团队,然后再重复创建;空的 documents 列表并不能证明上游未创建任何内容。