Gestion d’un groupe ad hoc

Les groupes ad hoc sont utiles lorsque vous souhaitez envoyer des documents à signer là où vous souhaitez un groupe spécifique de destinataires, et tout membre de ce groupe peut signer le document avec sa propre signature pour une seule transaction.

Pour activer les groupes ad hoc, veuillez contacter notre équipe de support.

Ajout d’un groupe ad hoc

Les groupes ad hoc et les membres peuvent être mis à jour via les appels POST suivants :

• API/packages (Partie de l’appel de création de transaction)

• api/packages/{packageId}/roles : Puisque cet appel permet de créer un seul destinataire à la fois, vous devrez d’abord ajouter les membres individuels comme signataires, puis ajouter le groupe ad hoc avec les associations de membres.

• api/packages/{packageId}/groups : Il s’agit d’un nouvel appel qui permet d’ajouter un groupe ad hoc et ses membres dans un seul appel. À noter qu’en tant que partie de la bêta, cet appel ne dispose d’aucune fonctionnalité de retour en arrière.

Bien qu’il signerType s’agisse d’une propriété optionnelle pour tous les signataires existants, elle doit être spécifiée pour le nouveau type de signataire du Groupe Ad Hoc. Voir Types de rôles et types de signataires pour la liste complète des types de rôles et types de signataires pris en charge dans le système.

Mise à jour d’un groupe ad hoc

Les groupes ad hoc et les membres peuvent être mis à jour via les appels PUT suivants :

• api/packages/{packageId}/roleID : Puisque cet appel permet de mettre à jour un seul destinataire à la fois, vous devrez mettre à jour les membres et le groupe ad hoc individuellement.

• api/packages/{packageId}/groups : Il s’agit d’un nouvel appel qui permet de mettre à jour un groupe ad hoc et ses membres lors d’un seul appel.  

Il ne sera pas possible de mettre à jour les informations ad hoc du groupe ou des membres ad hoc lorsqu’une signature acceptée existe pour eux.  Une erreur sera déclenchée.

À noter que lors de l’exécution d’un PUT sur le Rôle ou sur l’appel Groups, une logique de prétraitement est en place pour empêcher la création de données partielles.  Les éléments suivants sont validés :

• La fonction Groupes Ad Hoc est activée pour le compte

• La transaction/modèle n’est pas de type hébergé (en personne, iPen, RON, salle virtuelle)

• Le nom du Groupe Ad Hoc est spécifié et unique

• Le nombre de membres autorisés (10) n’est pas dépassé

Notes :

• Un nouveau type de signataire appelé AD_HOC_GROUP_SIGNER a été introduit.  Ce type de signataire sera utilisé pour identifier le destinataire du Groupe Ad Hoc.

• Un nouveau type de membre appelé AD_HOC_GROUP_MEMBER a été introduit. Ce type de membre sera utilisé pour identifier un destinataire qui n’est qu’un membre d’un groupe ad hoc et non un signataire individuel dans la transaction/modèle.

• Un nouveau type de membre appelé SIGNER a été introduit. Ce type de membre sera utilisé pour identifier un destinataire qui est à la fois membre d’un groupe ad hoc et un signataire individuel dans la transaction/modèle. Cela est uniquement pris en charge via l’API de la version Bêta.

• Une fois que le Groupe Ad Hoc et ses membres sont ajoutés comme rôles individuels, vous pouvez alors créer l’association entre eux via le modèle de signataire du Groupe Ad Hoc en utilisant leurs identifiants.

• Un seul type de membre peut être défini pour un destinataire donné. Si vous définissez différents types de membres pour un destinataire donné (par exemple, type de membre «SIGNER » dans Ad Hoc Group1 et type de membre «AD_HOC_GROUP_MEMBER » dans Ad Hoc Group2), une erreur sera affichée.

Bien qu’il signerType s’agisse d’une propriété optionnelle pour tous les signataires existants, elle doit être spécifiée pour le nouveau type de signataire du Groupe Ad Hoc. Voir Types de rôles et types de signataires pour la liste complète des types de rôles et types de signataires pris en charge dans le système.

REST API

Requête HTTP

POST /api/packages

En-têtes HTTP

Authorization: Basic api_key
Accept: application/json
Content-Type: application/json

Charge utile de demande

 "roles": [
        {
            "type": "SIGNER", 
            "id": "member-role-1",
            "signers": [
                {
                    "email": "johndoe@gmail.com",
                    "firstName": "John",
                    "lastName": "Doe",
                    "title":"",
                    "company":""
                }
            ]
        },
        {
            "type": "SIGNER",
            "id": "member-role-2",
            "signers": [
                {
                    "email": "janedoe@gmail.com",
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "title":"",
                    "company":"" 
                }
            ]
        },
        {
            "type": "SIGNER",
            "id": "member-signer-role-3",
            "signers": [
                {
                    "email": "jessycollins@gmail.com",
                    "firstName": "Jessy",
                    "lastName": "Collins",
                    "title":"",
                    "company":"" 
                }
            ]
        },          {
            "type": "SIGNER",   
            "id": "group-role-1",
            "signers": [
                {
                    "firstName": "Borrowers",
                    "signerType": "AD_HOC_GROUP_SIGNER",
                    "group": {
                        "members": [
                            {
                                "userId": "member-role-1",
								"memberType": "AD_HOC_GROUP_MEMBER"
                            },
                            {
                                "userId": "member-role-2",
								"memberType": "AD_HOC_GROUP_MEMBER"
                            },
                            {
                                "userId": "member-signer-role-3",
								"memberType": "SIGNER"
                            }                         
                        ]
                    }
                }
            ]
        }
    ]

Charge utile de réponse

{

"id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="

}

Requête HTTP

POST /api/packages/{packageId}/groups

En-têtes HTTP

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Charge utile de demande

 [
    {
        "type": "SIGNER",
        "id": "member-role-1",
        "signers": [
            {
                "firstName": "John",
                "lastName": "Doe",
			    "email": "johndoe@gmail.com",
                "company": "",
                "title": ""
            }
        ]        
    },
    {
         "type": "SIGNER",  
         "id": "member-role-2",
         "signers": [
            {
                "firstName": "Jane",
                "lastName": "Doe",
                "email": "janedoe@gmail.com",
                "company": "",
                "title": ""
            }
        ]
    },
    {
        "type": "SIGNER",
        "id": "group-role-1",
        "name": "Borrowers Role",
        "signers": [
            {
                "firstName": "Borrowers",
                "signerType": "AD_HOC_GROUP_SIGNER",
                "group": {
                    "members": [
                        {
                            "userId": "member-role-1",
                            "memberType": "AD_HOC_GROUP_MEMBER"
                        },
                        {
                            "userId": "member-role-2",
                            "memberType": "AD_HOC_GROUP_MEMBER"
                        }
                    ]
                }
            }
        ]
    }
]

Annexe

Rôles et types de signataires

Le tableau suivant présente les types de destinataires existants et nouveaux avec leur rôle associé et les types de signataires. Les nouveaux éléments sont marqués en gras.