Snapdocs Scheduling Open API
For Notary Connect companies, you can find everything you need to know about our API at the link here: https://mobilenotary.docs.apiary.io/#
The production API host is app.snapdocs.com.
To get your API key, please send the following to support@snapdocs.com:
1: Your desired callback URL
2: Response format (json or xml)
We'll send you an email back with the API key!
What the API CAN do:
- Send orders to Snapdocs
- Send documents to Snapdocs
- Send notary information to the TPS via the order response
- Update any order details
- Send comments to orders in Snapdocs
- receive comments from Snapdocs to TPS
- Send a list of products
- Send a list of clients
- Send order statuses:
open- This is an order that is currently being worked.completed- This is for an order where a signing has been successfully completed.canceled- This order is canceled. It will no longer be worked and you will not be charged for it.on_hold- This order is not being worked, but it may return to an open status at some point.did_not_sign- This is when a notary started work on an order, but for some reason it did not work out.
- The order field appointment_confirmation_status can have the following values:
unconfirmedconfirmedchange_requested
- The order field attachment_status can have the following values:
null- docs have not been sentsent_by_client- docs sent through API or by clientemailed_to_notary- docs emailed by schedulerdirect_links- docs emailed by schedulernotary_picked_up_docs- docs not emailedovernighted- docs not emailedat_closing- docs not emaileddownloaded- docs were emailed and notary has downloaded all of them
- Send order callbacks:
notary_assignednotary_removeddocuments_status_changedstatus_changed- refers to the order's signing statusautomator_stopped- only sent for company API keysnotary_fee_changed- only sent for company API keys, and only sent if notary has already been assignedscanback_addedappointment_confirmedappointment_change_requestedorder_comment_added
What the API CAN’T do:
- Support participants
- Clients cannot update the order status via the API but customers can.
- Note Client authentication tokens will only be able to use
cancelandon_hold.
- Note Client authentication tokens will only be able to use
- Create new clients from the TPS (must be done in Snapdocs)
- Create new products from the TPS (must be done in Snapdocs)
- Send scanbacks
- Scanbacks must be requested and will only appear when viewing order details
- We do send a scanback added event though.
- Scanbacks must be requested and will only appear when viewing order details
- Send order level invoices