Last modified: 2024-03-05

Création d'une transaction accessible

Une fois le PDF accessible créé, il doit être téléversé vers une transaction accessible.

Les transactions ne sont pas accessibles par défaut. Les expéditeurs doivent donc signaler manuellement une transaction comme étant accessible.

Le comportement par défaut ci-dessus peut être modifié, afin que les transactions soient accessibles par défaut. Pour ce faire, communiquez avec notre équipe de soutien.

Une transaction accessible peut être créée de l'une des manières suivantes :

Création d'une transaction accessible via l'interface utilisateur

Pour créer une transaction accessible ou un modèle accessible via la nouvelle expérience utilisateur, les expéditeurs doivent faire correspondre les champs de formulaire des documents ajoutés aux champs OneSpan Sign des destinataires. C'est ce que fait la procédure suivante.

Pour créer une transaction accessible ou un modèle accessible via la nouvelle expérience utilisateur :

  1. Créez une transaction ou créez un modèle.
  2. Dans l'écran contextuel, ouvrez la section PARAMÈTRES et faites glisser le commutateur à bascule Activer l'accessibilité du lecteur d'écran sur Activé.
  3. Cliquez sur Créer.
  4. Cliquez sur AJOUTER UN DOCUMENT. Dans la boîte de dialogue qui s'affiche, sélectionnez un document à ajouter à la transaction ou au modèle. Ce document doit être un PDF accessible aux personnes handicapées.
  5. Si le document contient des champs de formulaire (par exemple, des cases, des boutons radio), la boîte de dialogue Importation de champ apparaît.
  6. Cliquez sur DÉMARRER L'IMPORTATION. La page Définir les destinataires apparaît
  7. Ajoutez tous les destinataires ou les espaces réservés nécessaires à votre transaction ou modèle.
  8. Cliquez sur PROCHAIN. La page Importation de signatures de liens & s'affiche.
  9. Cliquez sur AJOUTER UNE SIGNATURE. Un menu déroulant Signature apparaît, contenant une liste de toutes les signatures du document.
  10. Dans le menu déroulant Signature, sélectionnez une signature. Cette signature sera liée au destinataire.
  11. Si les signatures facultatives sont activées sur votre compte, vous pouvez indiquer que la signature sélectionnée est facultative. Si ce drapeau est activé, le système n'obligera pas le destinataire à apposer toutes ses signatures à l'intérieur des documents de la transaction avant de conclure celle-ci.

  12. Un menu déroulant Type de signature apparaît. Utilisez-le pour sélectionner l'une des trois premières options suivantes pour votre signature sélectionnée (vous pouvez ou non sélectionner la quatrième option) :
    • Cliquez pour signer : Le nom du destinataire est apposé sur le champ de signature au moment de la signature. Il s'agit du type de signature par défaut. Nous le recommandons aux signataires qui sont aveugles et à ceux qui ont un handicap physique.
    • Signature par capture : Le signataire dessine sa signature à l'aide de sa souris ou d'un autre dispositif de saisie. Le dessin de la signature est apposé sur le champ de la signature au moment de la signature.
    • Cliquez pour initialiser : Pour signer ce type de document, le signataire doit simplement cliquer sur le bloc. Les initiales du signataire sont ensuite apposées sur le bloc.
    • Est facultatif : Par défaut, un champ de signature est requis. Toutefois, vous pouvez la rendre facultative en utilisant cette case à cocher.
  13. Une fois que le signataire a activé le mode accessibilité (comme il doit le faire pour signer de manière accessible), le logiciel OneSpan Sign lui donne des indications verbales sur le placement du curseur. Cela pourrait être particulièrement utile pour la méthode de la signature par capture.

  14. Cliquez sur PROCHAIN. La page Champs Importation et liens apparaît. C'est ici que vous pouvez spécifier les mappages des champs de votre document (par exemple, cases, boutons radio, zones de texte).
  15. Pour commencer le mappage, cliquez sur AJOUTER UN CHAMP. Un menu déroulant de champs apparaît, contenant une liste de tous les champs de formulaire disponibles dans votre document. Par défaut, les champs d'une transaction sont facultatifs. Toutefois, vous pouvez les rendre obligatoires en cochant la case Est obligatoire.
  16. Sélectionnez un champ de formulaire dans le menu Champ. Un menu déroulant de type de champ apparaît, contenant une liste de tous les champs disponibles sur OneSpan Sign.
  17. Les champs suivants OneSpan Sign suivants ne sont pas disponibles :

    • Champs personnalisés
    • Champs de notaires
    • Liste
    • Sélecteur de date
    • Champs d'étiquettes
  18. Sélectionnez un champ OneSpan Sign dans le menu déroulant Type de champ.
  19. Répétez les trois étapes précédentes pour chaque champ de formulaire que vous souhaitez mapper.
  20. Le fait de ne pas mapper un champ de formulaire peut avoir pour conséquence qu'il ne soit pas accessible.

  21. Cliquez sur PROCHAIN. Une nouvelle page donne un aperçu des mappages que vous avez créés.
  22. Revoyez vos mappages. Lorsque vous en êtes satisfait, cliquez sur TERMINÉ. Une fois ces mappages effectués, vous pouvez continuer à créer votre transaction ou enregistrer votre modèle pour une utilisation ultérieure

Création d'une transaction accessible via l'API

POST /paquets

Description

Crée un paquet « accessible » avec des binaires de documents. Les personnes handicapées pourront examiner et signer les documents contenus dans ce dossier.

Les documents du paquet doivent être des PDF convenablement étiquetés. Pour savoir comment les créer, consultez la rubrique Création d'un PDF accessible. Si les PDF ne sont pas marqués d'une balise, votre demande n'aboutira pas.

Cette section décrit comment créer un paquet accessible avec des documents joints. Si vous le souhaitez, vous pouvez créer un paquet accessible sans aucun document, puis ajouter les documents ultérieurement.

Informations sur les ressources

Méthode HTTP POST
Famille de ressources paquets
Authentification SDK Java
Type de contenu multipart/form-data
Accepter application/json

Exemple de demande

POST https://sandbox.e-signlive.com/api/packages/

Données utiles de la demande

Les données utiles de la demande doivent : (1) spécifier les champs et les signatures en utilisant les mêmes types que ceux donnés aux champs et aux signatures à l'intérieur des PDF étiquetés du paquet; (2) spécifier les champs et les signatures en utilisant les mêmes noms et ID que ceux donnés aux noms des champs et des signatures à l'intérieur des PDF étiquetés du paquet; (3) spécifier le nom et l'ID de chaque approbation en utilisant le même nom et ID de la signature associée; (4) mettre l'indicateur d'extraction à vrai pour tous les documents et champs pertinents.

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="file"; filename="Unsigned Document.doc"
Content-Type: application/msword

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="payload"

{
  "settings": {
    "ceremony": {
      "ada": true
    }
  },
  "type": "PACKAGE",
  "language": "en",
  "name": "<Package Name>",
  "documents": [
    {
      "approvals": [
        {
          "role": "Customer",
          "name": "CustomerSignature",
          "id": "CustomerSignature",
          "fields": [
            {
              "name": "APR",
              "id": "APR",

              "extract": true,
              "type": "INPUT",
              "subtype": "TEXTFIELD"
            },
            {
              "name": "CustomerSignature",
              "id": "CustomerSignature",
              "extract": true,
              "type": "SIGNATURE",
              "subtype": "FULLNAME"
            }
          ]
        },
        {
          "role": "Customer",
          "name": "Agent",
          "id": "Agent",
          "fields": [
            {
              "name": "Agent",
              "id": "Agent",
              "extract": true,
              "type": "SIGNATURE",
              "subtype": "FULLNAME"
            }
          ]
        }
      ],
      "extract": true,
      "index": 0,
      "name": "Doc 1"
    }
  ],
  "roles": [
    {
      "type": "SIGNER",
      "id": "Customer",
      "signers": [
        {
          "signature": null,
          "firstName": "role",
          "lastName": "one",
          "email": "<email address>",
          "id": "Customer"
        }
      ],
      "name": "Customer"
    }
  ]
}
------WebKitFormBoundary1bNO60n7FqP5WO4t--

Données utiles de la réponse

{
    "id": "4d09f2a8-4f0d-477b-8735-4b42ecf5ed0a"
}

Réponses aux erreurs

L'erreur suivante est créée si vous essayez de téléverser un PDF qui n'est pas balisé :

{
    "messageKey": "error.validation.ada.notTaggedDocument",
    "message": "Documents uploaded to accessible transactions must be accessibility enabled.",
    "code": 400,
    "name": "Validation Error"
}

L'erreur suivante est créée si vous essayez de téléverser un PDF dont les balises ne sont pas structurées correctement :

{
    "messageKey": "error.validation.ada.documentNotTaggedProperly",
    "message": "Documents uploaded to accessible transactions must be tagged properly.",
    "code": 400,
    "name": "Validation Error"
}

L'erreur suivante est créée si vous essayez de modifier l'indicateur ADA pour un paquet qui contient déjà des documents. Cette erreur ne se produit donc pas lorsque vous créez un paquet, mais uniquement lorsque vous mettez à jour un paquet.

{
    "messageKey": "error.validation.ada.documentsExist",
    "message": "The ADA flag cannot be updated once documents are uploaded",
    "code": 400,
    "name": "Validation Error"
}
Was this information helpful?
X