EasyLink is ultimately just an ease-of-life proxy into the Business and Real Estate APIs. As such, most of the parameters you can supply into those APIs are also acceptable by EasyLink.
Specifically, EasyLink is meant to mimic the transaction creation endpoint, effectively creating the transaction - transaction - A record of a document or group of documents to be signed or reviewed. Transactions "belong" to business accounts, and are delivered to signer accounts for notarization or proofing. Specific transaction parameters can be modified on creation, or prior to use. The transaction state is updated as it proceeds through creation, delivery to the signer, and completion. and then directly passing the customer through to sign that transaction.
Here's the general experience when someone visits an EasyLink that you've provided.
- Customer is redirected to the EasyLink prep screen, hosted on the Notarize website. This prep screen is available on both desktop and mobile.
The EasyLink prep screen.
- Customer is guided to upload a document. If the EasyLink has been pre-prepped with a document, then this step is skipped. If the customer is on mobile, then they'll be navigated to install the app, where the following steps will seamlessly resume.
The document upload screen.
- Customer is guided to sign-up with an email address. If the EasyLink has been pre-prepped with an email, then the customer will see that email now. They'll have a chance to change this email.
The signup screen.
- The customer continues through the rest of the notarization process, verifying their identity and meeting with an online notary by video chat.
- [optional] If specified, the customer is redirected to the site which first referred them to the EasyLink. This will let you make your customer experience as seamless as possible.
Post-EasyLink redirecting is currently not supported. Please stay tuned as the feature is fine-tuned and released. Please contact Support if you have any questions.
The base EasyLink URL is https://app.notarize.com/easy-link. All additional parameters must be appended to this URL as query string parameters.
Be sure to format your query string parameters correctly!
You can use the
All parameters are optional.
- ApiKey: Your API key. Make sure to use a client only API key, as whatever API key you use will be exposed when posting the EasyLink! By providing an API key, you'll be able to attribute any notarizations completed to your business account. If you don't provide one, a Notarize-belonging API key will be automatically supplied instead.
- document: A URL where the document you'd like customers to sign can be found. Any customer using your EasyLink will automatically have this document file prepared for them.
SuperTemplates are EasyLink compatible
As in the Business API, you can use a SuperTemplate to fill your EasyLink. Simply provide the permalink for the
document parameter. Note that at least one document in your EasyLink must have
identity_confirmation set to true, if only using SuperTemplates.
As in the Business API, you can also include multiple documents in your EasyLink. Use the
documents parameter instead, and include the parameter repeatedly, in order, for every document needed. For example:
- signer[email]: The email of your customer. Any customer using your EasyLink will have this email pre-filled for them. They'll have a chance to modify this email before signing up.
The above parameters will serve for most use cases. You can find a complete list of parameters described in the transaction creation endpoint.
After all that, you might end up with an EasyLink that looks something like the following:
https://app.notarize.com/easy-link?ApiKey=BSHh5NnLiqLs6C4GvPqQGkPz&document=https%3A%2F%2Fwww.notarize.com%2Ffake-document-url&signer[email]=fakeperson%40notarize.com // Notes for the above link: // ApiKey is BSHh5NnLiqLs6C4GvPqQGkPz // document is https://www.notarize.com/fake-document-url // signer[email] is firstname.lastname@example.org
For the sake of security or customer experience, some parameters are necessarily restricted when using EasyLink to create a transaction.
easy_link: For obvious reasons, the
easy_linkparameter will be set to
true. This will have the effect that the transaction won't appear in your Notarize dashboards, and you won't be able to modify the transaction after it's created, even if the customer hasn't actually begun notarizing it yet.
draft: Relatedly, EasyLink transaction will be auto-set to a state where
true. The transaction will be moved to the appropriate state as the customer uses it, but this may affect your internal accounting of your business's transactions.
suppress_email: Any EasyLink transaction will set
true. This means your customer won't receive an email alerting them to the transaction, even if you provide a customer email ahead of time.
require_new_signer_verification: Any EasyLink transaction will set
false. This means your customer won't be required to verify their email when beginning the transaction, unless someone else has already begun the transaction signing process, or the given email has other transactions/documents associated with it.
require_new_signer_verification are experimental parameters that may only apply to EasyLink. They may not apply at large to all Business API or Real Estate API transactions, and you use them at your own risk.
Additionally, any transaction created using EasyLink will only be active for up to 1 hour before it expires. That is, a customer must begin the notarization process within 1 hour after first using an EasyLink. If the transaction expires, the customer can re-use the EasyLink to make a new one.
API Key Restrictions
You can also apply individual restrictions to any API key you use, which will then apply as well if used in your EasyLink. See Authentication for more details.