SuperAPI AI 工具集

sumsub-supported-id-documents

安全与审计

查看项目

更新于 10-15 13:36

技能介绍

用途

该技能用于查询和编辑 Sumsub 内置的受支持身份证件目录(documentsByCountries),回答关于某国家、某证件类型是否受支持、是否双面、默认提取哪些 OCR 字段、哪些字段可选等问题。目录规模较大(约 250 个国家、约 1350 个国家/证件类型组合),技能不会把整个目录倾倒进对话,而是由本地 Python 脚本在进程内保留完整目录,只返回相关切片;当扁平列表过大时,会折叠为聚合摘要。

主要能力

  • 读取内置受支持证件目录(documentsByCountries),获取每个国家的默认值。
  • 读取客户当前设置,包括 idDocSettings.countryMappings 覆盖项。
  • 读取 Sumsub 内置的有效期延长规则(只读参考,支撑“官方延长证件”有效期模式)。
  • 通过 replace-all 的 PUT 接口编辑 idDocSettings.countryMappings,这是唯一的写入路径。
  • 提供有效识别状态查询、目录查询、有效期/有效性检查、完整设置转储等能力。

使用方式

所有接口使用 App Token 认证,权限为 manageClientSettings。环境变量包括 SUMSUB_APP_TOKEN(沙箱 App Token)、SUMSUB_SECRET_KEY(配对密钥)、SUMSUB_BASE(可选,默认 https://api.sumsub.com)。

主要端点:

  • GET /resources/api/agent/supportedDocs/documentsByCountries:读取内置目录。
  • GET /resources/api/agent/globalSettings:读取客户当前设置。
  • GET /resources/api/agent/globalSettings/extensionRules:读取内置有效期延长规则。
  • PUT /resources/api/agent/globalSettings/idDocSettings/countryMappings:替换全部国家映射。

注意两种 JSON 结构不同:目录 GET 的 countryMappings 在顶层;globalSettings 的 countryMappings 嵌套在 idDocSettings 下。字段采用 NON_NULL 序列化,缺失即默认值,接受类标志缺失即 false。PUT 为 replace-all,省略的条目会被清除并回退到目录默认值,因此写入必须通过脚本(build_country_mappings.py 合并变更到当前映射的新副本,remove_country_mapping.py 构建减去一条的映射),不要手工构造部分载荷,也不要复用陈旧的 /tmp/current.json。

适用场景

  • 查询某国家某证件类型的有效识别状态(默认使用方式 A)。
  • 查询抽象层面或跨国家的可能性(方式 B)。
  • 查询有效期/有效性检查,需同时报告 expirationCheckMode 和具体延长规则(方式 C)。
  • 查询某证件的完整处理设置,报告每个设置的开/关状态(方式 D)。
  • 编辑客户受支持证件:读取-修改-写入加 PUT。

限制

  • 仅限沙箱环境。
  • 不要从 Paler 源码(documents-by-countries.json、Java 源码等)回答,源码只含内置目录默认值,客户有效状态只在 API 后面。
  • 数据必须来自 get_global_settings.sh / get_supported_docs.sh / get_entitlements.sh。
  • 若变更设置 extraFields,需验证 ADVANCED_OCR 权益(付费附加项,未启用时后端会静默丢弃)。
  • 若变更设置 acceptScreenshots: true(禁用截图保护)等关键欺诈设置,需要明确警告。
  • 根级其他块(watchListCheckSettings、cryptoCheckSettings、bankCardCheckSettings、kybIntegrationSettings、uiSettings、duplicateSettings、sourceKeysSettings、applicantTags、supportEmail、disableSumsubId、idDocServiceSettings)不属于本技能领域。
  • 部分事实(如具体收费、价格、平台支持情况)暂未提供。