Pular para o conteúdo principal
Arquivos JSON contêm estruturas de dados que especificam a quantidade, os tipos e os nomes dos documentos, bem como a quantidade e os nomes das páginas de cada documento. Para configurar o envio via dispositivo móvel para os cenários de um usuário específico, use o arquivo JSON no link de upload móvel. O Parameter md pode aceitar um arquivo JSON em dois formatos: link direto codificado ou JSON codificado. Para usar um link codificado:
  1. Gere um link de acesso direto para o arquivo JSON.
Nota: O link deve começar com “http://” ou “https://”.
  1. Codifique o link obtido no formato URL-encoded.
  2. Informe a URL codificada como valor do Parameter md no link de upload móvel.
Para usar um JSON codificado:
  1. Codifique o arquivo JSON no formato URL-encoded.
  2. Informe o arquivo JSON codificado como valor do Parameter md no link de upload móvel.

​
Estrutura JSON

TransactionStructure define um conjunto de documentos que o usuário deve capturar durante uma sessão de upload em dispositivo móvel para processamento posterior em uma transação. A transação não será iniciada até que todos os documentos sejam capturados.
PropertiesValueDescription
version2.4A versão atual do ABBYY Vantage. Observação: o valor deve corresponder ao valor do parâmetro v no link de upload em dispositivo móvel.
elementsElementStructureA estrutura da coleção de elementos.
ElementStructure define uma coleção com um ou vários conjuntos de documentos que o usuário deve capturar para processamento posterior em uma transação.
PropertiesValueDescription
typestandaloneDefine uma coleção com um único conjunto de documentos.
typesingle_choiceDefine uma coleção com vários conjuntos de documentos. Observação: exige pelo menos dois conjuntos de documentos especificados.
nameO nome do conjunto de documentos que será exibido na tela Capture Documents no microaplicativo. Observação: disponível apenas para o tipo single_choice.
documentDocumentStructureA estrutura de um documento no conjunto. Observação: disponível apenas para o tipo standalone.
documentsDocumentStructureA estrutura de todos os documentos no conjunto. Observação: disponível apenas para o tipo single_choice.
DocumentStructure define uma coleção de propriedades para cada documento no conjunto.
PropertiesValueDescription
typeidcardDefine a captura de ambos os lados (frente e verso) de um documento de identificação.
typepassportDefine a captura da primeira página de um passaporte.
typedocumentDefine a captura de quaisquer documentos.
nameO nome do documento que será exibido na tela Capture Documents no microaplicativo.
count1,2,3...O número obrigatório de documentos a serem capturados em uma transação. O valor padrão é “1”. Observação: o upload não será iniciado até que todos os documentos sejam capturados.
countanyO número de documentos a serem capturados em uma transação. Observação: o upload será iniciado com qualquer quantidade de documentos capturados.
galleryEnabledfalse/trueDefine se é permitido fazer upload de imagens de páginas de documentos a partir da galeria do dispositivo para este documento.
pagesPagesStructureA estrutura das páginas do documento.
PagesStructure define uma coleção de propriedades para as páginas do documento que o usuário deve capturar.
PropertiesValueDescription
nameFront side/Back sideOs nomes das páginas de um documento de identificação.
nameFirst page with photoO nome da primeira página de um passaporte.
nameDocument page nameOs nomes das páginas de qualquer documento.
count1,2,3...O número obrigatório de páginas a serem capturadas para o documento. O valor padrão é “1”. O upload não será iniciado até que todas as páginas do documento sejam capturadas. Observação: o valor obrigatório para frente e verso de um documento de identificação é “1”.
countanyO número de páginas a serem capturadas para qualquer documento. O upload será iniciado com qualquer quantidade de páginas capturadas. Observação: o valor obrigatório para a primeira página de um passaporte é “1”. O valor obrigatório para as demais páginas do passaporte é “any”.

​
Exemplo de JSON

Um exemplo de estrutura JSON para capturar uma quantidade específica de documentos de passaporte com um número predefinido de páginas: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "Passaporte",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Primeira página com foto",
            "count": 1
          },
          {
            "name": "Outras páginas",
            "count": "qualquer"
          }
        ]
      }
    }
  ]
}
Exemplo de estrutura JSON para capturar um entre vários documentos predefinidos: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Documento",
      "documents": [
        {
          "type": "idcard",
          "name": "Carteira de Identidade",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Frente",
              "count": 1
            },
            {
              "name": "Verso",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Passaporte",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Primeira página com foto",
              "count": 1
            },
            {
              "name": "Outras páginas",
              "count": "qualquer"
            }
          ]
        }
      ]
    }
  ]
}
Exemplo de estrutura JSON para capturar múltiplos documentos, com um cartão de identificação opcional: 
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "Fatura",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Página",
            "count": "qualquer"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "Carteira de identidade",
        "count": "qualquer",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "Frente",
            "count": 1
          },
          {
            "name": "Verso",
            "count": 1
          }
        ]
      }
    }
  ]
}