Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Wednesday, March 2, 2016 at 06:32am
0
votes
Hi,
How to retrieve the status of the signer using REST API?
Especially for bounced email, opt-out and expired.
Thanks
March 2Created
January 21Last Updated
8 years agoLast Reply
7Replies
43Views
2Users
0Likes
0Links
mwilliams | Posts: 957
Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Wednesday, March 2, 2016 at 11:10am
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. :)
Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Wednesday, March 2, 2016 at 11:57am
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.
Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Thursday, March 3, 2016 at 06:41am
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:
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.
Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Friday, March 4, 2016 at 05:16am
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.
Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Monday, March 7, 2016 at 08:44am
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/
Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Wednesday, March 2, 2016 at 11:10amReply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Wednesday, March 2, 2016 at 11:57amReply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Thursday, March 3, 2016 at 05:12amReply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Thursday, March 3, 2016 at 06:41amhttps://sandbox.esignlive.com/api/packages/{packageId}/audit
You'd get back info like: 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.Reply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Friday, March 4, 2016 at 05:16amReply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Monday, March 7, 2016 at 08:34amReply to: Retrieve Signer’s status (bounced email, opt-out, expired) through REST API
Monday, March 7, 2016 at 08:44am