Business API Quick Start Guide

Spin up a transaction for your customer as quickly as possible! This guide outlines the sequence of API calls that you would typically need for an end-to-end Notarize integration.

Introduction

The Notarize Business API allows you to seamlessly send your signers documents for notarization and retrieve completed documents for use in your downstream business processes.

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 get started, please contact our sales team to get a Notarize Business account here.

1. Generate your API key.

Once you create a Notarize account, you will be able to generate your API key right from within your account.

To generate your API key, log into your Notarize Business account and navigate to Resources >> API Keys

2. Provide 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 Create Transaction endpoint.

3. Create a Transaction

Once you have decided what your transaction parameters will be, make a POST request to the Create Transaction endpoint. You can optionally include your documents in this request and create the transaction instantly, or you can mark the transaction as a draft and add documents later.

If you marked the transaction as a draft, you must follow step 4 to add documents to the transaction.

4. Add Documents to the Transaction

If you marked the transaction as a draft in step 3, call the Add Document endpoint to add the documents to be signed. You can specify the signing requirement (i.e. Notarization, eSign, etc.) in this API call (read more about document requirements here). All document attributes are also supported in the Update Documents endpoint.

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, you must 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.

5. Monitoring 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 further questions about the Business API, you can find full technical specifications at the API Endpoint Reference.


What’s Next

Engage more in-depth with the Business API, or move on to the Real Estate API.