Ajout, mise à jour et suppression de signataires

  • Mis à jour le Jul 28, 2025
  • Publié le Nov 18, 2024
  • 8 Minute(s) lue(s)
Prev Next

Java SDK .NET SDK REST API APEX SDK

Java SDK

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

L’une des opérations les plus fondamentales et les plus élémentaires de OneSpan Sign est d’inviter les signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d’une transaction.

Ajouter des signataires à une transaction

Pour ajouter un signataire à une transaction existante, vous devez d’abord créer l’objet Signataire . Le code suivant créera un objet Signataire :

Notez que cet exemple de code inclut également SMS notifications comme méthode de notification principale. Les méthodes de notification suivantes sont disponibles :

  • [EMAIL, SMS] - les notifications par e-mail et par SMS sont envoyées au signataire (le numéro de téléphone est obligatoire)

  • [EMAIL] - seules les notifications par e-mail sont envoyées au signataire (le numéro de téléphone est facultatif)

Signer signer = SignerBuilder.newSignerWithEmail("signer@example.com")
    .withFirstName("John")
    .withLastName("Smith")
    .withCustomId("Signer1")
    .build();
.withNotificationMethods(NotificationMethodsBuilder.newNotificationMethods()
        .withPrimaryMethods(NotificationMethod.EMAIL, NotificationMethod.SMS)
        .withPhoneNumber("+15141234567")))  // in E.164 international format
.withSigner(newSignerWithEmail("your.email@example.com")
		.withFirstName("YourFirstName")
		.withLastName("YourLastName"))

Pour plus d’informations sur la mise à jour des méthodes d’authentification utilisées pour les transactions, reportez-vous à la Authenticating Signers.

Une fois l’objet Signataire créé, recherchez le PackageId qui vous a été renvoyé lors de la création de la transaction et utilisez le client OneSpan Sign pour ajouter votre signataire. Pour ce faire, le code suivant :

String signerId = eslClient.getPackageService().addSigner(packageId, signer);

Mise à jour d’un signataire existant

De même, pour mettre à jour un signataire existant, vous devez créer un objet Signataire qui contient les mises à jour que vous souhaitez apporter à votre signataire. Pour ce faire, le code suivant :

Signer updatedSigner = SignerBuilder.newSignerWithEmail("mary.doe@example.com")
    .withFirstName("Mary")
    .withLastName("Doe")
    .withCustomId("Signer1")
    .build();

Une fois que vous avez mis à jour le signataire, recherchez le PackageId (la transaction) dans lequel vous souhaitez modifier ce signataire et utilisez le client OneSpan Sign pour mettre à jour le signataire. 

eslClient.getPackageService().updateSigner(packageId, updatedSigner);

Suppression de signataires d’une transaction

Pour supprimer un signataire d’une transaction, il suffit d’appeler la fonction removeSigner avec les chaînes packageId et signerId .

 eslClient.getPackageService().removeSigner(packageId, signerId);

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre colis, vous verrez votre signataire dans votre transaction.

Kit de développement logiciel (SDK) .NET

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

L’une des opérations les plus fondamentales et les plus élémentaires de OneSpan Sign est d’inviter les signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d’une transaction.

Ajouter des signataires à une transaction

Pour ajouter un signataire à une transaction existante, vous devez d’abord créer l’objet Signataire . Le code suivant créera un objet Signataire :

Notez que cet exemple de code inclut également SMS notifications comme méthode de notification principale. Les méthodes de notification suivantes sont disponibles :

  • [EMAIL, SMS] - les notifications par e-mail et par SMS sont envoyées au signataire (le numéro de téléphone est obligatoire)

  • [EMAIL] - seules les notifications par e-mail sont envoyées au signataire (le numéro de téléphone est facultatif)

Signer signer = SignerBuilder.NewSignerWithEmail("signer@example.com")
    .WithFirstName("John")
    .WithLastName("Smith")
    .WithCustomId("Signer1")
    .Build();
.WithNotificationMethods(NotificationMethodsBuilder.NewNotificationMethods()
        .WithPrimaryMethods(NotificationMethod.EMAIL, NotificationMethod.SMS)
        .WithPhoneNumber("+15141234567") // in E.164 international format
.WithSigner(SignerBuilder.NewSignerWithEmail("your.email@example.com")
			.WithFirstName("Your First Name")
			.WithLastName("Your Last Name"))

Une fois que vous avez mis à jour le signataire, recherchez le PackageId (la transaction) dans lequel vous souhaitez modifier ce signataire et utilisez le client OneSpan Sign pour mettre à jour le signataire. 

String signerId = eslClient.PackageService.AddSigner(packageId, signer);

Pour plus d’informations sur la mise à jour des méthodes d’authentification utilisées pour les transactions, reportez-vous à la Authenticating Signers.

Mise à jour d’un signataire existant

De même, pour mettre à jour un signataire existant, vous devez créer un objet Signataire qui contient les mises à jour que vous souhaitez apporter à votre signataire. Pour ce faire, le code suivant :

Signer updatedSigner = SignerBuilder.NewSignerWithEmail("mary.doe@example.com")
    .WithFirstName("Mary")
    .WithLastName("Doe")
    .WithCustomId("Signer1")
    .Build();

Une fois que vous avez mis à jour le signataire, recherchez le PackageId (la transaction) dans lequel vous souhaitez modifier ce signataire et utilisez le client OneSpan Sign pour mettre à jour le signataire. 

 eslClient.PackageService.UpdateSigner(packageId, updatedSigner);

Suppression de signataires d’une transaction

Pour supprimer un signataire d’une transaction, il suffit d’appeler la fonction removeSigner avec les chaînes packageId et signerId .

eslClient.PackageService.UpdateSigner(packageId, updatedSigner);

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre colis, vous verrez votre signataire dans votre transaction.

REST API

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

L’une des opérations les plus fondamentales et les plus élémentaires de OneSpan Sign est d’inviter les signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d’une transaction.

Ajouter des signataires à une transaction

Pour ajouter un signataire à une transaction existante, utilisez le code suivant :

Requête HTTP

POST /api/packages/{packageId}/roles

Pour plus d’informations sur la mise à jour des méthodes d’authentification utilisées pour les transactions, reportez-vous à la Authenticating Signers.

En-têtes HTTP

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

Charge utile de la demande

{
  "id": "Signer5",
  "type": "SIGNER",
  "signers": [
    {
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "id": "Signer5"
"phone": "+15141234567",
"notificationMethods": {
           "primary": ["EMAIL", "SMS"]
    }
  ],
  "name": "Signer5"
}

Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.

Charge utile de réponse

 {
  "id": "Signer5",
  "data": null,
  "specialTypes": [

  ],
  "emailMessage": null,
  "attachmentRequirements": [

  ],
  "locked": false,
  "reassign": false,
  "index": 0,
  "signers": [
    {
      "group": null,
      "language": "en",
      "signature": null,
      "id": "Signer5",
      "delivery": {
        "provider": false,
        "email": false,
        "download": false
      },
      "auth": {
        "scheme": "NONE",
        "challenges": [

        ]
      },
      "knowledgeBasedAuthentication": null,
      "data": null,
      "title": "",
      "company": "",
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "external": null,
      "updated": "2017-11-16T16:53:01Z",
      "phone": "",
      "professionalIdentityFields": [

      ],
      "userCustomFields": [

      ],
      "address": null,
      "created": "2017-11-16T16:53:01Z",
      "name": "",
      "specialTypes": [

      ]
    }
  ],
  "name": "Signer5",
  "type": "SIGNER"
}

Mise à jour d’un signataire existant

Pour mettre à jour un signataire (rôle) existant, créez d’abord une charge utile avec les mises à jour que vous souhaitez effectuer, puis utilisez les exemples de demande ci-dessous pour effectuer vos mises à jour. Utilisez le roleid que vous avez attribué dans la demande précédente.

Si vous n’avez pas attribué d’ID de rôle, un ID généré aléatoirement sera attribué par OneSpan Sign.

Requête HTTP

PUT /api/packages/{packageId}/roles/{roleId}

En-têtes HTTP

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

Charge utile de la demande

 {
  "type": "SIGNER",
  "signers": [
    {
      "email": "mary.doe@example.com",
      "firstName": "Mary",
      "lastName": "Doe"
    }
  ]
}

Charge utile de réponse

{
  "id": "Signer5",
  "data": null,
  "specialTypes": [

  ],
  "emailMessage": null,
  "attachmentRequirements": [

  ],
  "locked": false,
  "reassign": false,
  "index": 0,
  "signers": [
    {
      "group": null,
      "language": "en",
      "signature": null,
      "id": "Signer5",
      "delivery": {
        "provider": false,
        "email": false,
        "download": false
      },
      "auth": {
        "scheme": "NONE",
        "challenges": [

        ]
      },
      "knowledgeBasedAuthentication": null,
      "data": null,
      "title": "",
      "company": "",
      "email": "mary.doe@example.com",
      "firstName": "Mary",
      "lastName": "Doe",
      "external": null,
      "updated": "2017-11-16T16:53:01Z",
      "phone": "",
      "professionalIdentityFields": [

      ],
      "userCustomFields": [

      ],
      "address": null,
      "created": "2017-11-16T16:53:01Z",
      "name": "",
      "specialTypes": [

      ]
    }
  ],
  "name": "Signer5",
  "type": "SIGNER"
}

Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.

Suppression de signataires d’une transaction

Pour supprimer un signataire, vous devez effectuer une demande DELETE à l’URI suivant :

Requête HTTP

DELETE /api/packages/{packageId}/roles/{signerId}

En-têtes HTTP

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

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre colis, vous verrez votre signataire dans votre transaction.

Tableau des données utiles de la demande

Propriété

Type

Modifiable

Obligatoire

Faire défaut

Exemples de valeurs

id

corde

Oui

Non

n/a

Signataire5

réaffecter

booléen

Oui

Non

faux

vrai / faux

nom

corde

Oui

Non

n/a

Signataire5

id

corde

Oui

Non

n/a

Signataire5

type

corde

Oui

Non

SIGNATAIRE

SIGNATAIRE / EXPÉDITEUR

Signataires

Messagerie électronique

corde

Oui

Non

n/a

mail32@example.com

prénom

corde

Oui

Non

n/a

John

nomNom de famille

corde

Oui

Non

n/a

Forgeron

id

corde

Oui

Non

n/a

Signataire5

Téléphone

corde

Oui

Non

n/a

"+15141234567"

notificationMethods

objet

Oui

Non

n/a

{ « primaire » : [ « EMAIL » ] }

primaire

tableau

Oui

Non

n/a

["EMAIL"], ["EMAIL », « SMS"]

APEX SDK

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

L’une des opérations les plus fondamentales et les plus élémentaires de OneSpan Sign est d’inviter les signataires à signer des documents. Cette rubrique décrit comment ajouter, mettre à jour et supprimer des signataires d’une transaction.

Ajouter des signataires à une transaction

Pour ajouter un signataire à une transaction existante, vous devez d’abord créer l’objet Signataire . Le code suivant créera un objet Signataire :

ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role();
role.id = 'signer1';
role.signers = sdk.createRolesSigner('John', 'Smith', 'signer@example.com', 'CEO', 'ABC Bank');
sdk.helper.createRole(packageId, role);

Une fois l’objet Signataire créé, recherchez le PackageId qui vous a été renvoyé lors de la création de la transaction et utilisez le client OneSpan Sign pour ajouter votre signataire. Pour ce faire, le code suivant :

ESignLiveAPIObjects.Role retrievedRole = sdk.getRole(packageId, 'signer1');

Pour plus d’informations sur la mise à jour des méthodes d’authentification utilisées pour les transactions, reportez-vous à la Authenticating Signers.

Mise à jour d’un signataire existant

Pour mettre à jour un signataire existant, il vous suffit de modifier l’un de vos attributs Signataire en récupérant ce signataire. Tous les attributs, à l’exception de RoleID, peuvent être modifiés. Pour ce faire, le code suivant :

retrievedRole.signers.get(0).firstName = 'changed firstname';
retrievedRole.signers.get(0).lastName = 'changed lastname';
retrievedRole.signers.get(0).email = 'changed@example.com';

Ensuite, recherchez le PackageId dans lequel vous souhaitez modifier ce signataire et utilisez le SDK OneSpan Sign pour mettre à jour le signataire.

 sdk.updateRole(packageId,'signer1',retrievedRole);

Suppression de signataires d’une transaction

Pour supprimer un signataire d’une transaction, il suffit d’appeler la fonction deleteRole avec les chaînes packageID et roleId .

 sdk.helper.deleteRole(packageId, 'signer1');

Résultats

Après avoir exécuté votre code, si vous vous connectez à OneSpan Sign et accédez à votre colis, vous verrez votre signataire dans votre transaction.