Changing a Recipient

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

DocumentPackage superDuperPackage = PackageBuilder.newPackageNamed("Change Signer Example")
    .withSigner(
        SignerBuilder.newSignerWithEmail("mail32@example.com")
            .withFirstName("John")
            .withLastName("Smith")
            .canChangeSigner() // allow signer to be changed
    )
    .withDocument(
        DocumentBuilder.newDocumentWithName("First Document")
            .fromFile("C:/Users/hhaidary/Desktop/PDFs/doc1.pdf")
            .withSignature(
                SignatureBuilder.signatureFor("mail32@example.com")
                    .onPage(0)
                    .atPosition(500, 100)
            )
    )
    .build();

.NET SDK

DocumentPackage superDuperPackage = PackageBuilder.NewPackageNamed("Change Signer Example")
    .WithSigner(
        SignerBuilder.NewSignerWithEmail("mail32@example.com")
            .WithFirstName("John")
            .WithLastName("Smith")
            .CanChangeSigner() // allow signer to be changed
    )
    .WithDocument(
        DocumentBuilder.NewDocumentNamed("First Document")
            .FromFile("C:/Users/hhaidary/Desktop/PDFs/doc1.pdf")
            .WithSignature(
                SignatureBuilder.SignatureFor("mail32@example.com")
                    .OnPage(0)
                    .AtPosition(500, 100)
            )
    )
    .Build();

REST API

To download the full code sample see our Code Share site.

The Change Recipient feature enables a recipient to delegate their signature to another recipient. The delegating recipient must provide the email address and full name of the delegate. Optionally, the delegating recipient can also provide an email message for the delegate. Both recipients are notified of the recipient change, and are copied on the email message. If a recipient has delegated their signature, the transaction creator is also informed.

The following code will do this:

HTTP Request

  POST /api/packages/{packageId}/roles  

HTTP Headers

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

Request Payload

{
  "id": "Signer5",
  "reassign": true,
  "type": "SIGNER",
  "signers": [
    {
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "id": "Signer5"
    }
  ],
  "name": "Signer5"
}

For a complete description of each field, see the Request Payload table below.

Response Payload

{
  "id": "Signer5",
  "data": null,
  "specialTypes": [],
  "emailMessage": null,
  "attachmentRequirements": [],
  "locked": false,
  "reassign": true,
  "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"
}

Results

After running your code, transaction recipients will have the option of re-assigning their signing responsibilities to somebody else.

Request Payload Table

APEX SDK

ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role();
ESignLiveAPIObjects.Signer signer = new ESignLiveAPIObjects.Signer();

signer.firstName = 'firstName';
signer.lastName = 'lastName';
signer.email = 'signer@example.com';
signer.name = 'signer1';
signer.id = 'signer1';

role.signers = new List<ESignLiveAPIObjects.Signer> { signer };
role.id = 'signer1';
role.reassign = true; // allow change signer