Aller au contenu

Formulaires de création de dossiers

Les formulaires servent à la création de dossiers dans Trust and Sign sans utiliser l'API / les Web Services. Ils permettent un déploiement rapide de la solution sans intégration.

*** Prérequis à l’utilisation des formulaires de création de dossier ***

  • Toutes les fonctionnalités de l'API d'intégration ne sont pas disponibles avec les formulaires ;
  • Tous les documents à signer doivent être configurés en tant que modèle dans le Workflow ;
  • Les documents à signer doivent obligatoirement être des contrats avec des champs de formulaires ;
  • Les documents à signer doivent avoir autant de champs de signatures que de participants ;
  • Tous les participants signent tous les documents à signer ;

Intégration du web SDK

<body>
<div id="form"></div>

<script src="lib/netheos-form.js"></script>
<script>
   NetheosForm.init({
       baseUrl: 'TRUST_AND_SIGN_URL', 
       productPublicId: 'PRODUCT_PUBLIC_ID',
       workflowLabel: 'WORKFLOW_LABEL',
       divId: 'form',
       onStepChange: function (step) {
           ...
       },
       onComplete: function (clientFile) {
           ...
       }
   })
</script>
</body>

Le formulaire est ajouté dans la page html au sein de la balise ayant l'ID <div id="form"></div>.

Il est possible de définir des callbacks JavaScript pour deux types d'événements.

onStepChange(step)

Ce callback est appelé à chaque changement d'étape par l'utilisateur. Une étape a la structure suivante :

{
    "form": {
        "element": {},         // Élément HTML représentant le formulaire 
        "fields": [
            {
                "name": "",    // Nom du champ
                "element": {}, // Élément HTML représentant le champ
                "errors": []   // Liste des erreurs du champ (peut être FIELD_MISSING, EMAIL_FORMAT, IBAN_FORMAT, SIREN_FORMAT, INVALID_NAME, INVALID_PHONE_NUMBER, INVALID_DATE)
            }
        ],
        "fieldsInError": [],   // Liste des champs en erreur
        "errors": []           // Liste des erreurs du formulaire (peut être NOT_ENOUGH_PARTICIPANTS, TOO_MANY_PARTICIPANTS)
    }
}

onComplete(clientFile)

Ce callback est appelé à la soumission du formulaire par l'utilisateur. Un dossier client a la structure suivante :

{
    "clientFileUuid": "",      // UUID du dossier
    "accessToken": "",         // Token d'accès de l'utilisateur
    "signbookUrl": "",         // URL vers le signbook
    "signbookFrontUrl": ""     // URL vers la page englobante du signbook
}

Pour afficher le Signbook, il suffit d'inclure une iframe dans votre page et de paramêtrer la source avec l'URL clientFile.signbookUrl?token=clientFile.accessToken.

Documents à signer

Les documents à signer peuvent contenir les informations des participants du dossier. Les noms des champs du formulaire dans les contrats à signer doivent être nommés ainsi :

  • legalEntity_%s : Liste des champs pour une personne morale
legalEntity_ %s
prefix type de champs
  • Les Types de champs pour une personne morale sont :
Champ Description
LEGAL_ENTITY_NAME Nom
LEGAL_ENTITY_SIREN Siren
LEGAL_ENTITY_ADDRESS_1 Adresse ligne 1
LEGAL_ENTITY_ADDRESS_2 Adresse ligne 2
LEGAL_ENTITY_ADDRESS_3 Adresse ligne 3
LEGAL_ENTITY_ADDRESS_ZIP_CODE Code Postal
LEGAL_ENTITY_ADDRESS_CITY Ville
LEGAL_ENTITY_IBAN Iban
  • participant_%s_%d_%s
participant_ %s %d %s
prefix le type du participant (dans le parcours) Index du type de participant (Int) Type de champs
  • Les Types de champs pour un participant sont :
Champ Description
CIVILITY Civilité
EMAIL Email
FIRST_NAME Prénom
LAST_NAME Nom de famille
BIRTH_NAME Nom de naissance
BIRTH_PLACE Ville de naissance
BIRTH_DATE Date de naissance
POSTAL_ADDRESS_1 Adresse ligne 1
POSTAL_ADDRESS_2 Adresse ligne 2
POSTAL_ADDRESS_3 Adresse ligne 3
POSTAL_ADDRESS_ZIP_CODE Code Postal
POSTAL_ADDRESS_CITY Ville
POSTAL_ADDRESS_COUNTRY_CODE Code du Pays
MOBILE_PHONE Téléphone portable
PHONE Téléphone fixe
IBAN Iban