Saltar al contenido principal
Los archivos JSON contienen estructuras de datos que especifican la cantidad, los tipos y los nombres de los documentos, así como la cantidad y los nombres de las páginas de cada documento. Para configurar la carga desde dispositivos móviles para los escenarios de un usuario específico, use el archivo JSON en el enlace de carga móvil. El parámetro md puede aceptar un archivo JSON en dos formatos: enlace directo codificado o JSON codificado. Para usar un enlace codificado:
  1. Genere un enlace de acceso directo al archivo JSON.
Nota: El enlace debe comenzar con “http://” o “https://”.
  1. Codifique el enlace obtenido en formato codificado para URL.
  2. Especifique la URL codificada como valor del parámetro md en el enlace de carga móvil.
Para usar un JSON codificado:
  1. Codifique el archivo JSON en formato codificado para URL.
  2. Especifique el archivo JSON codificado como valor del parámetro md en el enlace de carga móvil.

​
Estructura JSON

TransactionStructure define un conjunto de documentos que el usuario debe capturar durante una sesión de carga móvil para su posterior procesamiento en una transacción. La transacción no se iniciará hasta que se capturen todos los documentos.
PropertiesValueDescription
version2.4La versión actual de ABBYY Vantage. Nota: El valor debe corresponder al valor del parámetro v en el enlace de carga móvil.
elementsElementStructureLa estructura de la colección de elementos.
ElementStructure define una colección de uno o varios conjuntos de documentos que el usuario debe capturar para su posterior procesamiento en una transacción.
PropertiesValueDescription
typestandaloneDefine una colección con un único conjunto de documentos.
typesingle_choiceDefine una colección con múltiples conjuntos de documentos. Nota: Requiere al menos dos conjuntos de documentos especificados.
nameEl nombre del conjunto de documentos que se mostrará en la pantalla Capture Documents de la microaplicación. Nota: Disponible solo para el tipo single_choice.
documentDocumentStructureLa estructura de un documento del conjunto. Nota: Disponible solo para el tipo standalone.
documentsDocumentStructureLa estructura de todos los documentos del conjunto. Nota: Disponible solo para el tipo single_choice.
DocumentStructure define una colección de propiedades para cada documento del conjunto.
PropertiesValueDescription
typeidcardDefine la captura de ambas caras (anverso y reverso) de un documento de identidad.
typepassportDefine la captura de la primera página de un pasaporte.
typedocumentDefine la captura de cualquier documento.
nameEl nombre del documento que se mostrará en la pantalla Capture Documents de la microaplicación.
count1,2,3...La cantidad requerida de documentos que se deben capturar en una transacción. El valor predeterminado es “1”. Nota: La carga no comenzará hasta que se capturen todos los documentos.
countanyLa cantidad de documentos que se deben capturar en una transacción. Nota: La carga comenzará con cualquier número de documentos capturados.
galleryEnabledfalse/trueIndica si se permite cargar imágenes de páginas de documentos desde la galería del dispositivo para este documento.
pagesPagesStructureLa estructura de las páginas del documento.
PagesStructure define una colección de propiedades para las páginas del documento que el usuario debe capturar.
PropertiesValueDescription
nameFront side/Back sideLos nombres de las páginas de un documento de identidad.
nameFirst page with photoEl nombre de la primera página de un pasaporte.
nameDocument page nameLos nombres de las páginas de cualquier documento.
count1,2,3...La cantidad requerida de páginas que se deben capturar para el documento. El valor predeterminado es “1”. La carga no comenzará hasta que se capturen todas las páginas del documento. Nota: El valor requerido para el anverso y el reverso de un documento de identidad es “1”.
countanyLa cantidad de páginas que se deben capturar para cualquier documento. La carga comenzará con cualquier número de páginas capturadas. Nota: El valor requerido para la primera página de un pasaporte es “1”. El valor requerido para otras páginas del pasaporte es “any”.

​
Ejemplo de JSON

Ejemplo de una estructura JSON para capturar un monto específico de documentos de pasaporte con un número predeterminado de páginas: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "Pasaporte",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Primera página con foto",
            "count": 1
          },
          {
            "name": "Otras páginas",
            "count": "cualquier número"
          }
        ]
      }
    }
  ]
}
Ejemplo de estructura JSON para capturar uno de varios documentos predefinidos: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Document",
      "documents": [
        {
          "type": "idcard",
          "name": "Documento de identidad",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Anverso",
              "count": 1
            },
            {
              "name": "Reverso",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Pasaporte",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Primera página con foto",
              "count": 1
            },
            {
              "name": "Otras páginas",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
Un ejemplo de estructura JSON para capturar varios documentos con una tarjeta de identificación opcional: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "Factura",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Página",
            "count": "cualquiera"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "Documento de identidad",
        "count": "cualquiera",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Anverso",
            "count": 1
          },
          {
            "name": "Reverso",
            "count": 1
          }
        ]
      }
    }
  ]
}