开发者

GET/v3/documents

列出注册资料

使用旧版接口提供的有限字段集,查找账户下处于有效状态的本地资料。

本页
  1. 查找现有注册资料
  2. 列表请求
  3. 响应列表
  4. 返回的资料字段
  5. 后续步骤

查找现有注册资料

列出与您的 API 账户关联、处于有效状态且未被删除的本地注册资料。可先用此列表找到资料的 UUID,再通过 get_document 打开资料;此列表不能用于判断其证明材料或号码注册是否已获批准。

列表请求

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/documents

此处理程序未实现请求正文、分页或筛选参数。它返回匹配账户中存储的资料;请勿假定结果按特定顺序排列。对于资料量较大的账户,请避免频繁轮询完整列表。

响应列表

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": [
    {
      "id": "11111111111111111111111111111111",
      "first_name": "Example",
      "last_name": "Person",
      "phone_number": "12025550123",
      "id_number": "",
      "birth_date": null,
      "company_name": "",
      "company_reg_number": "",
      "vat_id": "",
      "personal_tax_id": "",
      "description": "Example profile",
      "identity_type": "Personal",
      "postal_code": "00000",
      "city": "Example City",
      "address": "1 Example Street",
      "signature": "BASE64_PNG_SIGNATURE_DATA",
      "date_created": "2026-10-23 16:00:00"
    }
  ]
}

如果没有匹配的有效资料,处理程序将返回 API 状态码 200 和空响应列表。response[].id 是创建时以 uuid 字段返回的本地资料 UUID;它不是身份 ID,也不是地址 ID。

返回的资料字段

返回的字段集包含 id、first_name、last_name、phone_number、id_number、birth_date、company_name、company_reg_number、vat_id、personal_tax_id、description、identity_type、postal_code、city、address、signature 和 date_created。

根据存储的数据,可选值可能为空或 null。此旧版字段集不包含 email、国家选择字段、identity_id、address_id、已上传文件的引用、证明材料列表和验证状态。此端点不能用于查询证明材料状态或注册审批结果。请将返回的身份、联系方式和签名数据作为私密信息处理。

后续步骤

请保存原始 create_document 响应中的实体 ID,以便后续关联附件。如果该响应已丢失,此列表无法找回这些 ID。请在 门户 中查看资料,或联系支持团队,而不要自动创建重复资料。