跳转到主要内容
JSON 文件包含数据结构，用于指定文档的数量、类型和名称，以及每个文档的页面数量和名称。要为特定用户场景配置移动端上传，请在移动端上传链接中使用该 JSON 文件。 md 参数可以接受两种格式的 JSON 文件：直接访问链接（经 URL 编码）或经过编码的 JSON。 要使用已编码的链接：
  1. 生成指向 JSON 文件的直接访问链接。
注意： 链接应以 “http://” 或 “https://” 开头。
  1. 将获得的链接编码为 URL 编码格式。
  2. 在移动端上传链接中将编码后的 URL 指定为 md 参数的值。
要使用已编码的 JSON：
  1. 将 JSON 文件编码为 URL 编码格式。
  2. 在移动端上传链接中将编码后的 JSON 文件指定为 md 参数的值。

​
JSON 结构

TransactionStructure 定义了用户在一次移动端上传会话中预期要采集的一组文档，这些文档将用于在事务中进行后续处理。在所有文档都采集完成之前，事务不会启动。
PropertiesValueDescription
version2.4当前的 ABBYY Vantage 版本。**注意：**该值应与移动上传链接中的 v 参数值一致。
elementsElementStructure元素集合的结构。
ElementStructure 定义了一个或多个文档集合，这些集合中的文档预期由用户采集，以便在事务中进行后续处理。
PropertiesValueDescription
typestandalone定义仅包含一组文档的集合。
typesingle_choice定义包含多组文档的集合。**注意：**至少需要指定两组文档。
name将在微应用的 Capture Documents 屏幕上显示的文档集合名称。**注意：**仅对 single_choice 类型可用。
documentDocumentStructure集合中单个文档的结构。**注意：**仅对 standalone 类型可用。
documentsDocumentStructure集合中所有文档的结构。**注意：**仅对 single_choice 类型可用。
DocumentStructure 定义了集合中每个文档的属性集合。
PropertiesValueDescription
typeidcard定义采集身份证双面（正反面）。
typepassport定义采集护照的首页。
typedocument定义采集任意文档。
name将在微应用的 Capture Documents 屏幕上显示的文档名称。
count1,2,3...在一次事务中要求采集的文档数量。默认值为 “1”。**注意：**在所有文档采集完成之前，上传不会开始。
countany在一次事务中要采集的文档数量。**注意：**上传会在采集到任意数量的文档后开始。
galleryEnabledfalse/true定义是否允许从设备相册上传该文档页面的图像。
pagesPagesStructure文档页面的结构。
PagesStructure 定义了用户预期要采集的文档页面的属性集合。
PropertiesValueDescription
nameFront side/Back side身份证各页面的名称。
nameFirst page with photo护照首页的名称。
nameDocument page name任意文档各页面的名称。
count1,2,3...该文档要求采集的页面数量。默认值为 “1”。在文档的所有页面都采集完成之前，上传不会开始。**注意：**身份证正反两面的必需值均为 “1”。
countany任意文档要采集的页面数量。上传会在采集到任意数量的页面后开始。**注意：**护照首页的必需值为 “1”，其他护照页面的必需值为 “any”。

​
JSON 示例

用于捕获特定数量、且每份包含预定义页数的护照文档的 JSON 结构示例： 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "Passport",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "First page with photo",
            "count": 1
          },
          {
            "name": "Other pages",
            "count": "any"
          }
        ]
      }
    }
  ]
}
用于捕获多个预定义文档类型之一的 JSON 结构示例： 
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Document",
      "documents": [
        {
          "type": "idcard",
          "name": "ID Card",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Front side",
              "count": 1
            },
            {
              "name": "Back side",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Passport",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "带照片的首页",
              "count": 1
            },
            {
              "name": "Other pages",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
用于采集多个文档和一个可选的身份证件的 JSON 结构示例： 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "Invoice",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Page",
            "count": "any"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "ID Card",
        "count": "any",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Front side",
            "count": 1
          },
          {
            "name": "Back side",
            "count": 1
          }
        ]
      }
    }
  ]
}