Entrée JSON - ABBYY Documentation

Les fichiers JSON contiennent des structures de données qui spécifient le nombre, les types et les noms des documents, ainsi que le nombre et les noms des pages pour chaque document. Pour configurer le téléversement mobile pour les scénarios d’un utilisateur donné, utilisez le fichier JSON dans le lien de téléversement mobile. Le paramètre md peut accepter un fichier JSON selon deux formats : lien direct encodé ou JSON encodé. Pour utiliser un lien encodé :

Générez un lien d’accès direct vers le fichier JSON.

Le lien doit commencer par “http://” ou “https://”.

Encodez le lien obtenu au format URL encodée.
Indiquez l’URL encodée comme valeur du paramètre md dans le lien de téléversement mobile.

Pour utiliser un JSON encodé :

Encodez le fichier JSON au format URL encodée.
Indiquez le fichier JSON encodé comme valeur du paramètre md dans le lien de téléversement mobile.

Structure JSON

TransactionStructure définit un ensemble de documents que l’utilisateur doit capturer lors d’une session de téléversement mobile pour un traitement ultérieur dans une transaction. La transaction ne commencera pas tant que tous les documents n’auront pas été capturés.

Properties	Value	Description
`version`	`2.4`	La version actuelle d’ABBYY Vantage. Remarque : La valeur doit correspondre à la valeur du paramètre `v` dans le lien de téléversement mobile.
`elements`	ElementStructure	La structure de la collection d’éléments.

ElementStructure définit une collection d’un ou de plusieurs ensembles de documents que l’utilisateur doit capturer pour un traitement ultérieur dans une transaction.

Properties	Value	Description
`type`	`standalone`	Définit une collection avec un seul ensemble de documents.
`type`	`single_choice`	Définit une collection avec plusieurs ensembles de documents. Remarque : Nécessite au moins deux ensembles de documents spécifiés.
`name`		Le nom de l’ensemble de documents qui sera affiché sur l’écran Capture Documents dans la micro‑application. Remarque : Disponible uniquement pour le type `single_choice`.
`document`	DocumentStructure	La structure d’un document de l’ensemble. Remarque : Disponible uniquement pour le type `standalone`.
`documents`	DocumentStructure	La structure de tous les documents de l’ensemble. Remarque : Disponible uniquement pour le type `single_choice`.

DocumentStructure définit une collection de propriétés pour chaque document de l’ensemble.

Properties	Value	Description
`type`	`idcard`	Définit la capture des deux faces (recto et verso) d’une carte d’identité.
`type`	`passport`	Définit la capture de la première page d’un passeport.
`type`	`document`	Définit la capture de tout type de document.
`name`		Le nom du document qui sera affiché sur l’écran Capture Documents dans la micro‑application.
`count`	`1,2,3...`	Le nombre requis de documents à capturer dans une transaction. La valeur par défaut est « 1 ». Remarque : Le téléversement ne commencera pas tant que tous les documents n’auront pas été capturés.
`count`	`any`	Le nombre de documents à capturer dans une transaction. Remarque : Le téléversement commencera avec n’importe quel nombre de documents capturés.
`galleryEnabled`	`false/true`	Indique si le téléversement d’images des pages de document depuis la Galerie de l’appareil est autorisé pour ce document.
`pages`	PagesStructure	La structure des pages du document.

PagesStructure définit une collection de propriétés pour les pages du document que l’utilisateur doit capturer.

Properties	Value	Description
`name`	`Front side/Back side`	Les noms des pages d’une carte d’identité.
`name`	`First page with photo`	Le nom de la première page d’un passeport.
`name`	`Document page name`	Les noms des pages de tout document.
`count`	`1,2,3...`	Le nombre requis de pages à capturer pour le document. La valeur par défaut est « 1 ». Le téléversement ne commencera pas tant que toutes les pages du document n’auront pas été capturées. Remarque : La valeur requise pour le recto et le verso d’une carte d’identité est « 1 ».
`count`	`any`	Le nombre de pages à capturer pour tout document. Le téléversement commencera avec n’importe quel nombre de pages capturées. Remarque : La valeur requise pour la première page d’un passeport est « 1 ». La valeur requise pour les autres pages du passeport est « any ».

Exemple JSON

Cet exemple JSON définit la structure des documents pour une demande bancaire. Les pages de document suivantes doivent être capturées par l’utilisateur lors d’une session de téléversement mobile, pour être ensuite traitées dans une transaction :

La première page du passeport.
Toutes les pages de la demande.
Un justificatif de domicile, comprenant les pages du contrat de location ou celles de la facture de services publics.

Afficher l’exemple 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"
            }
          ]
        }
      ]
    }
  ]
}

​Structure JSON

​Exemple JSON

Structure JSON

Exemple JSON