The Notarize Business API allows you to quickly and seamlessly send your signer and documents into Notarize to complete their necessary documents. This guide outlines the sequence of API calls that you would typically need for an end-to-end Notarize integration.
🎯Primary Audience: Notarize for Business
🚨Important: API keys are available to Business accounts in the Pro or higher tier. To get started with a Notarize for Business account, contact our sales team here.
The API, organized around REST, is designed to have predictable, resource-oriented URLs, and uses HTTP response codes to indicate any API errors. Webhooks are available to enable you to be notified when a transaction changes state.
To jump to a section, select a link below.
2. Decide the transaction parameters
4. Add your documents to the transaction
6. Retrieve the completed transaction
1. Generate your API key
After you create a Notarize account, generate your API key from within your account. To generate your key, follow the instructions below.
- Sign in to your account.
- Click your business name in the upper right of your Notarize account.
- Select Account Settings from the dropdown menu.
- Click API Keys from the menu on the left.
2. Decide the transaction parameters
These parameters allow you to customize your transaction for internal necessities as well as for the signer experience. You can set things like transaction_name, file_number, a message_to_signer, etc. A full list of parameters can be found in the Transactions - Create endpoint.
Specifically, we recommend the following:
- draft_sign: true
3. Create your transaction
Once you have decided what your transaction parameters will be, it will be time to create the transaction. Make a POST request to the Transactions - Create endpoint.
4. Add your documents to the transaction
Notarize supports .pdf file types supplied either as a URL or as a base64 encoded local file. You can also pass a document with PDF bookmarks so each bookmark becomes its own individual document in the transaction. If you do so, set the pdf_bookmarked attribute to true.
If you are passing a pdf_bookmarked document, it will take the Notarize system time to split the document. We will respond with a 200 and a response indicating that document upload is in progress. Should you wish to set your document parameters on a pdf_bookmarked document, you must first wait for this upload to complete (~5min), recall the document object on the transaction, and use the document ID returned to update the documents flags.
You can find a full list of supported document parameters in the Documents - Add to transaction ] endpoint. These parameters allow you set document level permissions such as notarization_required or witness_required. All document attributes are also supported in the [Update Document] endpoint.
5. Monitor the transaction
You can leverage Notarize WebHooks to monitor the state of the transaction. There are several events fired — for example you will be able to see when your signer has received and opened their transaction email as well as when they have completed their signing.
6. Retrieve the completed transaction
The Retrieve Transaction endpoint will return links to the completed documents. Alternatively, the binary file content can be returned of each document by using the Retrieve Document endpoint.
📘 If you have questions about the Notarize Business API, find full technical specifications at the API Endpoint Reference.
CONFIDENTIAL. © 2022-2023 Notarize, Inc.