Cata | Posts: 7

Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
Hi, How to retrieve the status of the signer using REST API? Especially for bounced email, opt-out and expired. Thanks

mwilliams | Posts: 957

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
The best way to retrieve all of this information would be to set up a listener and use callback notifications. For help setting these up, take a look, here: https://www.esignlive.com/blog/e-signlive-how-to-setting-up-callbacks/ You can find information about the callbacks available, here (this is also linked from the blog): http://docs.e-signlive.com/doku.php?id=esl:e-signlive_guide_event-notification This blog will show you how to check a package's status with REST: https://www.esignlive.com/blog/e-signlive-for-new-users-check-package-status-and-download-files-rest-api/ If you don't want to use the listener approach and still have questions about checking the status of a package/signer with REST, let me know. :)

Cata | Posts: 7

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
Thanks for answer, but I cannot use a callback. I need to use a polling approach. I am looking to use a REST API and retrieve the status of the signer. I was able to figure out the Accepted and Signed statuses from the last example, but I do not know how to retrieve the which signer has opted out or who's email has bounced. I could only see an OPT_OUT status for the whole package, but not at signer level. And for bounced email, I could not find a way to see what signer does not have a valid email.

mwilliams | Posts: 957

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
Okay. I will look into it and let you know. Trying to get a bounced email to test on. Hopefully I'll have something for you, soon.

mwilliams | Posts: 957

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
For checking which signer opted out, the way to do that would likely be to grab the audit trail for the package and see who opted out. The request url would be like: https://sandbox.esignlive.com/api/packages/{packageId}/audit You'd get back info like:
{
  "package-id": "b50aad14-1be8-4e2d-8841-faaa6a51f356",
  "audit-events": [
    {
      "type": "Login",
      "date-time": "2016-03-03 17:22:13",
      "target": "EMAIL_LINK",
       "user": "Signer Name",
      "user-email": "[email protected]",
      "user-ip": "72.209.184.10",
      "data": ""
    },
    {
      "type": "Signing Session For Signer",
      "date-time": "2016-03-03 17:22:13",
      "target": "test status opt out",
       "user": "Signer Name",
      "user-email": "[email protected]",
      "user-ip": "72.209.184.10",
      "data": "Signing session to signer : [email protected](Signer Name"
    },
    {
      "type": "View",
      "date-time": "2016-03-03 17:22:17",
      "target": "Electronic Disclosures and Signatures Consent",
       "user": "Signer Name",
      "user-email": "[email protected]",
      "user-ip": "72.209.184.10",
      "data": null
    },
    {
      "type": "Opt Out",
      "date-time": "2016-03-03 17:22:35",
      "target": "test status opt out",
      "user": "Signer Name",
      "user-email": "[email protected]",
      "user-ip": "72.209.184.10",
      "data": "Opt Out Reason: Signer's reason for opting out"
    }
  ]
}
As you can see, there is a listing in the JSON with type "Opt Out". If a package is opted out, you could look here to find who opted out and their "opt out reason". As soon as I get a bounced email, I'll let you know if there's a way to figure this out besides the callback notification.

Cata | Posts: 7

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
Thanks. That worked out good for Opted Out. We still need to figure out how to determine bounced emails at Signer level (who's email has bounced) through REST API.

Cata | Posts: 7

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
Is there any solution to finding out about bounced emails at Signer level (who’s email has bounced) through REST API?

mwilliams | Posts: 957

Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API

0 votes
Unfortunately, the only way to do the bounced email check is to either monitor the emails that go to your account email address or to have a listener to handle the callback notifications. This would be a great enhancement request though, to make this part of the signer object. If you could please post about this in the enhancement request forum, that'd be great! https://developer.esignlive.com/forums/forum/general/enhancement-ideas/

Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off