Agregar, actualizar y eliminar firmantes

 Signer signer = SignerBuilder.newSignerWithEmail("[email protected]")   .withFirstName("John")   .withLastName("Smith")   .withCustomId("Signer1")   .build(); 

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

 Signer updatedSigner = SignerBuilder.newSignerWithEmail("[email protected]")   .withFirstName("Mary")   .withLastName("Doe")   .withCustomId("Signer1")   .build(); 

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

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

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Una de las operaciones más fundamentales y básicas de OneSpan Sign es la de invitar a firmantes Un participante en una transacción, según lo especificado por el creador de la transacción. Tenga en cuenta que, en ocasiones, se utiliza el término "firmante" en lugar del término "destinatario". a firmar documentos. En este tema se describe cómo agregar, actualizar y eliminar firmantes de una transacción.

Agregar firmantes a una transacción

Para agregar un firmante a una transacción existente, debe crear primero el objeto Signer. El siguiente código creará un objeto Signer:

 Signer signer = SignerBuilder.NewSignerWithEmail("[email protected]")   .WithFirstName("John")   .WithLastName("Smith")   .WithCustomId("Signer1")   .Build(); 

Una vez que haya actualizado el firmante, busque el PackageId (la transacción) en el que desea cambiar este firmante y use el cliente de OneSpan Sign para actualizar el firmante.

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

Para obtener información sobre la actualización de los métodos de autenticación utilizados para las transacciones, consulte Autenticar firmantes.

Actualizar un firmante existente

Del mismo modo, para actualizar un firmante existente, debe crear un objeto Signer que contenga las actualizaciones que desea realizar al firmante. El siguiente código hará lo siguiente:

 Signer updatedSigner = SignerBuilder.NewSignerWithEmail("[email protected]")   .WithFirstName("Mary")   .WithLastName("Doe")   .WithCustomId("Signer1")   .Build(); 

Una vez que haya actualizado el firmante, busque el PackageId (la transacción) en el que desea cambiar este firmante y use el cliente de OneSpan Sign para actualizar el firmante.

 eslClient.PackageService.UpdateSigner(packageId, updatedSigner); 

Eliminar firmantes de una transacción

Para eliminar un firmante de una transacción, simplemente llame a la función removeSigner con el packageId y la cadena signerId.

 eslClient.PackageService.RemoveSigner(packageId, signerId); 

Resultados

Después de ejecutar su código, si inicia sesión en OneSpan Sign y navega hasta su paquete, verá su firmante en su transacción.

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Una de las operaciones más fundamentales y básicas de OneSpan Sign es la de invitar a firmantes Un participante en una transacción, según lo especificado por el creador de la transacción. Tenga en cuenta que, en ocasiones, se utiliza el término "firmante" en lugar del término "destinatario". a firmar documentos. En este tema se describe cómo agregar, actualizar y eliminar firmantes de una transacción.

Agregar firmantes a una transacción

Para agregar un firmante a una transacción existente, utilice el siguiente código:

Solicitud HTTP

POST /api/packages/{packageId}/roles

Para obtener información sobre la actualización de los métodos de autenticación utilizados para las transacciones, consulte Autenticar firmantes.

Encabezados HTTP

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

Carga útil de solicitud

{
  "id": "Signer5",
  "type": "SIGNER",
  "signers": [
    {
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Smith",
      "id": "Signer5"
    }
  ],
  "name": "Signer5"
}

Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente.

Carga útil de respuesta

 {
  "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": "[email protected]",
      "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"
}

Actualizar un firmante existente

Para actualizar un firmante existente (rol), primero cree una carga útil con las actualizaciones que desea realizar y, luego, use los ejemplos de solicitud mostrados a continuación para realizar sus actualizaciones. Utilice el roleid que asignó en la solicitud anterior.

Si no asignó ningún roleid, se asignará un ID generado aleatoriamente por OneSpan Sign.

Solicitud HTTP

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

Encabezados HTTP

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

Carga útil de solicitud

 {
  "type": "SIGNER",
  "signers": [
    {
      "email": "[email protected]",
      "firstName": "Mary",
      "lastName": "Doe"
    }
  ]
}

Carga útil de respuesta

{
  "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": "[email protected]",
      "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"
}

Para obtener una descripción completa de cada campo, consulte la tabla Carga útil de solicitud siguiente.

Eliminar firmantes de una transacción

Para eliminar un firmante, realice una solicitud DELETE al siguiente URI:

Solicitud HTTP

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

Encabezados HTTP

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

Resultados

Después de ejecutar su código, si inicia sesión en OneSpan Sign y navega hasta su paquete, verá su firmante en su transacción.

Tabla de carga útil de solicitud

Propiedad	Tipo	Editable	Obligatorio	Predeterminado	Valores de ejemplo
id	string	Sí	No	n/a	Signer5
reassign	boolean	Sí	No	false	true / false
name	string	Sí	No	n/a	Signer5
id	string	Sí	No	n/a	Signer5
type	string	Sí	No	FIRMANTE	FIRMANTE / REMITENTE
signers
email	string	Sí	No	n/a	[email protected]
firstName	string	Sí	No	n/a	Ernesto
lastName	string	Sí	No	n/a	Puente
id	string	Sí	No	n/a	Signer5

Para descargar la muestra de código completa, consulte nuestro sitio Code Share.

Una de las operaciones más fundamentales y básicas de OneSpan Sign es la de invitar a firmantes Un participante en una transacción, según lo especificado por el creador de la transacción. Tenga en cuenta que, en ocasiones, se utiliza el término "firmante" en lugar del término "destinatario". a firmar documentos. En este tema se describe cómo agregar, actualizar y eliminar firmantes de una transacción.

Agregar firmantes a una transacción

Para agregar un firmante a una transacción existente, debe crear primero el objeto Signer . El siguiente código creará un objeto Signer :

  ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role();   role.id = 'signer1';   role.signers = sdk.createRolesSigner('John', 'Smith', '[email protected]', 'CEO', 'ABC Bank');   sdk.helper.createRole(packageId, role); 

Una vez creado el objeto Signer, encuentre el PackageId devuelto durante la creación de la transacción y use el cliente de OneSpan Sign para agregar su firmante. El siguiente código hará lo siguiente:

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

Para obtener información sobre la actualización de los métodos de autenticación utilizados para las transacciones, consulte Autenticar firmantes.

Actualizar un firmante existente

Para actualizar un firmante existente, simplemente modifique cualquiera de sus atributos Signer , recuperando ese firmante. Es posible modificar todos los atributos, con la excepción de RoleID. El siguiente código lo realiza:

 retrievedRole.signers.get(0).firstName = 'changed firstname';   retrievedRole.signers.get(0).lastName = 'changed lastname';   retrievedRole.signers.get(0).email = '[email protected]'; 

Luego, busque el PackageId en el que desea cambiar este firmante y use el SDK de OneSpan Sign para actualizar el firmante.

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

Eliminar firmantes de una transacción

Para eliminar un firmante de una transacción, simplemente llame a la función deleteRole con el packageID y la cadena roleId .

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

Resultados

Después de ejecutar su código, si inicia sesión en OneSpan Sign y navega hasta su paquete, verá su firmante en su transacción.