Entrada JSON - ABBYY Documentation

Los archivos JSON contienen estructuras de datos que especifican el número, los tipos y los nombres de los documentos, así como el número y los nombres de las páginas de cada documento. Para configurar la carga móvil para los escenarios de un usuario específico, utilice 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:

Genere un enlace de acceso directo al archivo JSON.

El enlace debe comenzar con “http://” o “https://”.

Codifique el enlace obtenido al formato URL codificado.
Especifique la URL codificada como valor del parámetro md en el enlace de carga móvil.

Para usar un JSON codificado:

Codifique el archivo JSON al formato URL codificado.
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.

Properties	Value	Description
`version`	`2.4`	La versión actual de ABBYY Vantage. Nota: El valor debe corresponder al valor del parámetro `v` en el enlace de carga móvil.
`elements`	ElementStructure	La 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.

Properties	Value	Description
`type`	`standalone`	Define una colección con un único conjunto de documentos.
`type`	`single_choice`	Define una colección con múltiples conjuntos de documentos. Nota: Requiere al menos dos conjuntos de documentos especificados.
`name`		El 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`.
`document`	DocumentStructure	La estructura de un documento del conjunto. Nota: Disponible solo para el tipo `standalone`.
`documents`	DocumentStructure	La 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.

Properties	Value	Description
`type`	`idcard`	Define la captura de ambas caras (anverso y reverso) de un documento de identidad.
`type`	`passport`	Define la captura de la primera página de un pasaporte.
`type`	`document`	Define la captura de cualquier documento.
`name`		El nombre del documento que se mostrará en la pantalla Capture Documents de la microaplicación.
`count`	`1,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.
`count`	`any`	La cantidad de documentos que se deben capturar en una transacción. Nota: La carga comenzará con cualquier número de documentos capturados.
`galleryEnabled`	`false/true`	Indica si se permite cargar imágenes de páginas de documentos desde la galería del dispositivo para este documento.
`pages`	PagesStructure	La 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.

Properties	Value	Description
`name`	`Front side/Back side`	Los nombres de las páginas de un documento de identidad.
`name`	`First page with photo`	El nombre de la primera página de un pasaporte.
`name`	`Document page name`	Los nombres de las páginas de cualquier documento.
`count`	`1,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”.
`count`	`any`	La 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

Este ejemplo de JSON define la estructura del documento para una solicitud bancaria. Se espera que el usuario capture las siguientes páginas del documento durante una sesión de carga móvil para su posterior procesamiento en una transacción:

La primera página del pasaporte.
Todas las páginas de la solicitud.
Un comprobante de domicilio, que incluye las páginas del contrato de alquiler o las páginas de la factura de servicios públicos.

Mostrar ejemplo de JSON

{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "name": "Passport",
        "type": "passport",
        "count": "1",
        "galleryEnabled": false,
        "pages": [
          {
            "name": "First page with photo",
            "count": "1"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "name": "Application",
        "type": "document",
        "count": "1",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Page",
            "count": "any"
          }
        ]
      }
    },
    {
      "type": "single_choice",
      "name": "Proof of residence",
      "documents": [
        {
          "name": "Rental agreement",
          "type": "document",
          "count": "1",
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Page",
              "count": "any"
            }
          ]
        },
        {
          "name": "Utility bill",
          "type": "document",
          "count": "2",
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Page",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}

​Estructura JSON

​Ejemplo de JSON

Estructura JSON

Ejemplo de JSON