NAV
cURL

Overview

Resources

/v1/transactions
/v1/documents
/v1/notarization_records

The Notarize API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. Keep reading below for more information on each specific resource and endpoint.

Getting Started

In order to start working with our API, you must first create a Notarize for Business account. Once you have completed account setup, please contact partnerships@notarize.com with your account information to request an API key. If you plan to process a large number of transactions with Notarize, you may also wish to request a volume-based pricing agreement.

Authentication

curl https://api.notarize.com/v1/transactions \
  -H "ApiKey: test_key_1234"

In order to authenticate with the API, you must send your API key with each request using the ApiKey header.

Asset URLs

All asset URLs returned by the Notarize API (documents, images) are signed S3 links served over HTTPS. All links returned will expire in 15 minutes to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.

Request IDs

Every API request has an associated request identifier. You can find this value in the response headers, under X-Request-Id. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Enterprise Features

Some of our APIs require Enterprise Features to be enabled for your account. Please contact your account representative or partnerships@notarize.com to have any of these features enabled. API features that require an Enterprise feature are indicated throughout the documentation.

Feature Description
multi-document feature Create transactions that include multiple documents.
two-signer feature Enable documents to be signed by two signers during a single signing session.
expiration feature Set an expiration time on transactions, after which they cannot be completed.

Sandbox Mode

Sandbox Resources

/sandbox/v1/transactions
/sandbox/v1/documents
/sandbox/v1/notarization_records

Our sandbox allows you to validate that your requests are crafted correctly and that you can handle transaction responses at every stage of the lifecycle without creating real production transactions. The transactions and notarization records returned in the sandbox are hard-coded and will not reflect your input parameters. To use the Partner API in sandbox mode, simply prepend /sandbox to the resource URIs.

API Reference

Transactions

The transactions endpoint allows you to send notarization requests to your customers and check on the status of those requests.

Create a transaction

POST /v1/transactions HTTP/1.1

Create a transaction with a local file

curl https://api.notarize.com/v1/transactions \
  -H "ApiKey: test_key_1234"\
  -F "document=@path/to/your/document.pdf" \
  -F "signer[email]=miguel.lee@notarize.com" \
  -F "signer[first_name]=Miguel" \
  -F "signer[last_name]=Lee" \
  -F "transaction_name=Miguel's TPS notarization for Leeroy" \
  -F "transaction_type=Power of Attorney" \
  -F "message_to_signer=Please notarize your TPS Report." \
  -F "message_signature=Love, Leeroy."

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
        "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
        "date_created": "2017-05-09T17:09:52.248711Z",
        "date_updated": "2017-05-09T17:09:52.248711Z",
        "document_name": "document.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
      }],
  "transaction_name": "Miguel's TPS notarization for Leeroy",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "sent",
  "require_secondary_photo_id": false
}

Create a transaction with document URL

curl https://api.notarize.com/v1/transactions \
  -H "ApiKey: test_key_1234"\
  --data-urlencode "document=https://path.to/your/document.pdf" \
  -d "signer[email]=miguel.lee@notarize.com" \
  -d "signer[first_name]=Miguel" \
  -d "signer[last_name]=Lee" \
  -d "transaction_name=Miguel's TPS notarization for Leeroy" \
  -d "transaction_type=Power of Attorney" \
  -d "message_to_signer=Please notarize your TPS Report." \
  -d "message_signature=Love, Leeroy."

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
        "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
        "date_created": "2017-05-09T17:09:52.248711Z",
        "date_updated": "2017-05-09T17:09:52.248711Z",
        "document_name": "document.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    }],
  "transaction_name": "Miguel's TPS notarization for Leeroy",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "sent",
  "require_secondary_photo_id": false
}

Create a Multi-Document transaction

curl https://api.notarize.com/v1/transactions \
  -H "ApiKey: test_key_1234"\
  -H 'Content-Type: application/json' \
  -d \
'
{
    "documents": ["http://www.pdf995.com/samples/pdf.pdf","http://che.org.il/wp-content/uploads/2016/12/pdf-sample.pdf"],
    "transaction_name" : "Miguels MultiDocument notarization for Leeroy",
    "transaction_type" : "Power of Attorney",
    "message_to_signer" : "Please notarize these Documents",
    "message_signature": "Thanks, Leeroy.",
    "signer":{
        "email":"miguel.lee@notarize.com",
       "first_name": "Miguel",
        "last_name": "Lee"
    },
    "suppress_email":true,
    "draft": true
}
'

Response

{
    "id": "ot_bd5j5n9",
    "date_created": "2017-05-09T16:46:39.823232Z",
    "date_updated": "2017-05-09T16:46:39.823232Z",
    "transaction_name": "Miguels MultiDocument notarization for Leeroy",
    "transaction_type": "Power of Attorney",
    "message_to_signer": "Please notarize these Documents",
    "message_signature": "Thanks, Leeroy.",
    "documents": [{
        "id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
        "date_created": "2017-05-09T16:46:39.767123Z",
        "date_updated": "2017-05-09T16:46:39.767123Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    }, {
        "id": "do_d0e14332-bc40-493d-b710-48719bf077b5",
        "date_created": "2017-05-09T16:46:40.685716Z",
        "date_updated": "2017-05-09T16:46:40.685716Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
    "status": "started",
    "signer_info": {
        "email": "miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee",
        "transaction_access_link": "",
        "link_expired": true
    },
    "require_secondary_photo_id": false
}

Create a cosigned transaction

curl https://api.notarize.com/v1/transactions \
  -H "ApiKey: test_key_1234"\
  -H 'Content-Type: application/json' \
  -d \
'
{
    "documents": ["http://www.pdf995.com/samples/pdf.pdf","http://che.org.il/wp-content/uploads/2016/12/pdf-sample.pdf"],
    "transaction_name" : "Miguels MultiDocument notarization for Leeroy",
    "transaction_type" : "Power of Attorney",
    "message_to_signer" : "Please notarize these Documents",
    "message_signature": "Thanks, Leeroy.",
    "signer": {
        "email":"miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee"
    },
    "cosigner": {
        "first_name": "Peter",
        "last_name": "Pepper"
    },
    "suppress_email":true,
    "draft": true
}
'

Response

{
    "id": "ot_bd5j5n9",
    "date_created": "2017-05-09T16:46:39.823232Z",
    "date_updated": "2017-05-09T16:46:39.823232Z",
    "transaction_name": "Miguels MultiDocument notarization for Leeroy",
    "transaction_type": "Power of Attorney",
    "message_to_signer": "Please notarize these Documents",
    "message_signature": "Thanks, Leeroy.",
    "documents": [{
        "id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
        "date_created": "2017-05-09T16:46:39.767123Z",
        "date_updated": "2017-05-09T16:46:39.767123Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    }, {
        "id": "do_d0e14332-bc40-493d-b710-48719bf077b5",
        "date_created": "2017-05-09T16:46:40.685716Z",
        "date_updated": "2017-05-09T16:46:40.685716Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
    "status": "started",
    "signer_info": {
        "email": "miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee",
        "transaction_access_link": "",
        "link_expired": true
    },
    "cosigner_info": {
            "first_name": "Peter",
            "last_name": "Pepper"
    },
    "require_secondary_photo_id": false
}

This endpoint creates a transaction and by default triggers our standard notarization workflow, sending an email to the customer requesting them to complete the transaction. To create a transaction in draft state (i.e. transaction is in started state), so it can be modified before sending, set the Draft attribute to true. Transactions created in Draft, or with state started, will need to be activated by calling the notarization_ready endpoint to trigger the notarization workflow.

The notarization workflow that gets triggered on activation is described below:

The document to be notarized can be added to a transaction in one of two ways:

When the multi-document feature is enabled, multiple documents can also be sent for notarization in a single transaction. In this case an array of document URLs are passed in with the documents attribute.

ARGUMENTS

name description
document
optional
Document to be notarized, supplied as a URL or local file. Only PDFs are supported. When local file is used, the maximum file size of the document is 10MB. This field is required if the transaction is not being created as a draft ({ "draft": "false"}).
documents
optional
multi-document feature
Used instead of the document attribute to send multiple document transactions. Documents to be notarized are supplied as an array of document URLs. The documents will be presented for signature in the order in which they are supplied, unless the order is updated via the documents_order object. Only PDFs are supported. This field is required if the transaction is not being created as a draft ({ "draft": "false"}).
signer
required
A signer object with at minimum the email field set. The request to notarize the document will be sent to that email address.
cosigner
optional
two-signer feature
A cosigner object with both the first_name and the last_name defined.
expiry
optional
expiration feature
An ISO-8061 formatted DateTime String, optionally including the timezone offset. If timezone offset is not provided, the account’s default timezone settings will be applied. This param sets an expiration timeperiod on the transaction, after which the signer cannot complete the transaction.his param sets an expiration period on the transaction.
external_id
optional
A string representing an ID external to Notarize’s systems. Use this to associate a transaction to an ID that your systems understand, such as a User ID.
transaction_type
optional
Short, human-readable description of the transaction. Can be used to categorize transactions by their purpose or by general type — e.g. Account Opening or Power of Attorney.
transaction_name
optional
Short, human-readable name for the transaction - eg. Miguel's TPS notarization for Leeroy. Defaults to Untitled Transaction.
message_to_signer
optional
Message to signer. Can be used to provide instructions, thank customers, add additional context to the transaction, or simply to add a personal touch. Plain text only. The message will be added to the email sent to the signer.
message_signature
optional
A message signature to append to message_to_signer.
allow_signer_annotations
optional
defaults to false
Determines whether a signer can annotate document. If true, the signer may pre-fill the document in advance of the notary meeting, with a broad set of annotation options. If false, the signer can only modify the document during the notary meeting, and annotation options are limited to those intended to be witnessed by a notary, such as signing and dating the document.
require_secondary_photo_id
optional
defaults to false
Certain businesses and transaction types may need signers to provide two forms of photo identification. This feature enables you to require two forms on a transaction. If true, the signer cannot proceed to the notary meeting without first providing two forms of photo ID during the Notarize identity verification process. If false (default), the signer can proceed to notary meeting after providing one form of photo ID.
draft
optional
defaults to false
When set to true, the transaction will be created in a Draft state. This attribute is typically used when managing multi-document transactions. When the transaction is in draft state, transaction attributes can be modified and additional documents can be added to the bundle, using the documents API. To activate the transaction, the notarization_ready API endpoint must be called.
suppress_email
optional
defaults to false
When set to true, Notarize does not send a notification email to the signer when the transaction is activated. If you use this feature, you are responsible for providing the signer with the transaction_access_link.

RETURNS

Returns a transaction object if the command is successful.

Example Email from Notarize

Here’s an example of an email from Notarize sent to a signer when a transaction is created:

alt text

The status field

A transaction changes between one of the following states.

value description
started The transaction was created but it is still in draft mode and can be modified.
sent The transaction was prepared and an invitation email has been sent to the signer.
received The signer has received and opened the invitation email.
completed_pending_charge The notarization was completed successfully but the transaction_record cannot be released until the customer completes the payment. This status is only possible if the business account is configured to CUSTOMER_PAYS.
completed The notarization was completed successfully and the notarization_record can be fetched for more information.
expired
expiration feature
Expiration date on the transaction was passed before the transaction was completed.

Retrieve a Transaction

GET /v1/transactions/{TRANSACTION_ID} HTTP/1.1

Retrieve a transaction

curl https://api.notarize.com/v1/transactions/ot_anpr8qn \
  -H "ApiKey: test_key_1234"\

Retrieves the transaction with a given ID. You need to supply the unique transaction ID that was returned upon transaction creation.

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
        "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
        "date_created": "2017-05-09T17:09:52.248711Z",
        "date_updated": "2017-05-09T17:09:52.248711Z",
        "document_name": "document.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
      }],
  "transaction_name": "Miguel's TPS notarization for Leeroy.",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "created",
  "require_secondary_photo_id": false
}

ARGUMENTS

name description
id
required
The identifier of the transaction to be retrieved.

RETURNS

Returns a transaction object if the command is successful.

List Transactions

GET /v1/transactions HTTP/1.1

List transactions with limit and offset

curl -X GET "https://api.notarize.com/v1/transactions/?limit=2&offset=1" \
  -H "ApiKey: test_key_1234"\

Response

{
  "data" : [
    {
      "id": "ot_anpr8qn",
      "date_created": "2016-10-01T18:52:44.725Z",
      "date_updated": "2016-10-02T20:13:54.245Z",
      "signer_info": {
        "email": "miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee",
        "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
      },
      "documents": [{
            "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
            "date_created": "2017-05-09T17:09:52.248711Z",
            "date_updated": "2017-05-09T17:09:52.248711Z",
            "document_name": "document.pdf",
            "allowed_actions": ["NOTARIZATION_REQUIRED"],
            "bundle_position": 0
          }],
      "transaction_name": "Miguel's TPS notarization for Leeroy.",
      "transaction_type": "Power of Attorney",
      "message_to_signer": "Please notarize your TPS Report.",
      "status": "sent",
      "require_secondary_photo_id": false
    },
    {
      "id": "ot_anpr8qn",
      "date_created": "2016-10-01T18:52:44.725Z",
      "date_updated": "2016-10-02T20:13:54.245Z",
      "signer_info": {
        "email": "miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee",
        "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
      },
      "documents": [{
                "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
                "date_created": "2017-05-09T17:09:52.248711Z",
                "date_updated": "2017-05-09T17:09:52.248711Z",
                "document_name": "pdf.pdf",
                "allowed_actions": ["NOTARIZATION_REQUIRED"],
                "bundle_position": 0
            }, {
                "id": "do_d46a3751-399f-4149-b7b2-d46aea498011",
                "date_created": "2017-05-09T17:09:52.872688Z",
                "date_updated": "2017-05-09T17:09:52.872688Z",
                "document_name": "pdf-sample.pdf",
                "allowed_actions": ["NOTARIZATION_REQUIRED"],
                "bundle_position": 1
            }],
      "transaction_name": "Miguel's TPS notarization for Leeroy.",
      "transaction_type": "Power of Attorney",
      "message_to_signer": "Please notarize your TPS Report.",
      "message_signature": "Love, Leeroy.",
      "status": "sent",
      "require_secondary_photo_id": false
    }
  ],
  "count": 2
}

Returns a list of transactions. The returned transactions are sorted by creation date, with the most recently created transactions appearing first.

ARGUMENTS

name description
limit
optional
How many results to return, default=10, max 100, must be an integer
offset
optional
Return requested # of items starting with the value, default=0, must be an integer

RETURNS

A dictionary with a data property that contains an array of up to limit transactions, starting at index offset. Each entry in the array is a separate transaction object. If no more transactions are available, the resulting array will be empty.

Resend a Transaction Invitation Email

POST /v1/transactions/{TRANSACTION_ID}/send_email HTTP/1.1

Send a transaction invitation email

curl https://api.notarize.com/v1/transactions/ot_anpr8qn/send_email \
  -H "ApiKey: test_key_1234"\

On occasion, a customer may lose or accidentally delete the email containing the transaction access link. You can use this method to resend the email and enable the signer to proceed.

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
                "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
                "date_created": "2017-05-09T17:09:52.248711Z",
                "date_updated": "2017-05-09T17:09:52.248711Z",
                "document_name": "document.pdf",
                "allowed_actions": ["NOTARIZATION_REQUIRED"],
                "bundle_position": 0
            }],
  "transaction_name": "Miguel's TPS notarization for Leeroy.",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "sent",
  "require_secondary_photo_id": false
}

ARGUMENTS

name description
message_to_signer
optional
The message_to_signer used when the transaction was first sent will be reused if this argument is not provided.

RETURNS

Returns a transaction object if the command is successful.

Activate a Draft Transaction

POST /v1/transactions/{TRANSACTION_ID}/notarization_ready HTTP/1.1

Activating the transaction

curl https://api.notarize.com/v1/transactions/ot_anpr8qn/notarization_ready \
  -H "ApiKey: test_key_1234"\

If the transaction is created in draft mode, it will be necessary to activate the transaction before the notarization workflow can get triggered. This is done by calling the notarization_ready method.

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
        "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
        "date_created": "2017-05-09T17:09:52.248711Z",
        "date_updated": "2017-05-09T17:09:52.248711Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    }, {
        "id": "do_d46a3751-399f-4149-b7b2-d46aea498011",
        "date_created": "2017-05-09T17:09:52.872688Z",
        "date_updated": "2017-05-09T17:09:52.872688Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
  "transaction_name": "Miguel's TPS notarization for Leeroy.",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "sent",
  "require_secondary_photo_id": false
}

ARGUMENTS

name description
id
required
The identifier of the transaction to be retrieved.
suppress_email
optional
default false
When set to true, Notarize does not send a notification email to the signer when the transaction is activated. If you use this feature, you are responsible for providing the signer with the transaction_access_link.

RETURNS

Returns a transaction object if the command is successful.

Delete a transaction

DELETE /v1/transactions/{TRANSACTION_ID} HTTP/1.1

Deleting a transaction

curl -X "DELETE" https://api.notarize.com/v1/transactions/ot_anpr8qn/notarization_ready \
  -H "ApiKey: test_key_1234"\

It might sometimes be necessary to delete a created transaction. This method can be called to perform this action as long as the transaction has not been completed.

Response

{
  "message":"Deleted Transaction ot_anpr8qn successfully"
}

ARGUMENTS

name description
id
required
The identifier of the transaction to be deleted.

RETURNS

200 if the message was successfully deleted.

Update a draft transaction

PUT /v1/transactions/{TRANSACTION_ID} HTTP/1.1

Update transaction parameters

curl -X "PUT" https://api.notarize.com/v1/transactions/ot_anpr8qn \
  -H "ApiKey: test_key_1234"\
  -H 'Content-Type: application/json' \
  -d \
'
{
    "transaction_name": "Updated Transaction",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please re-notarize these Documents",
  "message_signature": "Thanks, Leeroy.",
  "signer": {
        "email":"Jana.Lewis@notarize.com",
        "first_name": "Jana",
        "last_name": "Lewis"
  },
  "suppress_email": true,
  "draft": true
}
'

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "Jana.Lewis@notarize.com",
    "first_name": "Jana",
    "last_name": "Lewis",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [
    {
        "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
        "date_created": "2017-05-09T17:09:52.248711Z",
        "date_updated": "2017-05-09T17:09:52.248711Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    },
    {
        "id": "do_d46a3751-399f-4149-b7b2-d46aea498011",
        "date_created": "2017-05-09T17:09:52.872688Z",
        "date_updated": "2017-05-09T17:09:52.872688Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
  "transaction_name": "Updated Transaction",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please re-notarize these Documents",
  "message_signature": "Love, Leeroy.",
  "status": "started",
  "require_secondary_photo_id": false
}

Update the document bundle order

curl https://api.notarize.com/v1/transactions/ot_anpr8qn \
  -H "ApiKey: test_key_1234"\
  -H 'Content-Type: application/json' \
  -d \
'
{
    "documents": [
            {"document_id":"do_d46a3751-399f-4149-b7b2-d46aea498011","bundle_position":0 },
            {"document_id":"do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934", "bundle_position":1}
    ]
}

Response

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
        "id": "do_d46a3751-399f-4149-b7b2-d46aea498011",
        "date_created": "2017-05-09T17:09:52.872688Z",
        "date_updated": "2017-05-09T17:09:52.872688Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
         "bundle_position": 0
        },
        {
        "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
        "date_created": "2017-05-09T17:09:52.248711Z",
        "date_updated": "2017-05-09T17:09:52.248711Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
  "transaction_name": "Miguel's TPS notarization for Leeroy.",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "started",
  "require_secondary_photo_id": false
}

Update cosigner information

curl https://api.notarize.com/v1/transactions/<TRANSACTION_ID> \
  -H "ApiKey: test_key_1234"\
  -H 'Content-Type: application/json' \
  -d \
'
{
    "cosigner": {
        "first_name": "Sam",
        "last_name": "Pepper"
    },
    "suppress_email":true,
    "draft": true
}
'

Response

{
    "id": "ot_bd5j5n9",
    "date_created": "2017-05-09T16:46:39.823232Z",
    "date_updated": "2017-05-09T16:46:39.823232Z",
    "transaction_name": "Miguels MultiDocument notarization for Leeroy",
    "transaction_type": "Power of Attorney",
    "message_to_signer": "Please notarize these Documents",
    "message_signature": "Thanks, Leeroy.",
    "documents": [{
        "id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
        "date_created": "2017-05-09T16:46:39.767123Z",
        "date_updated": "2017-05-09T16:46:39.767123Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    }, {
        "id": "do_d0e14332-bc40-493d-b710-48719bf077b5",
        "date_created": "2017-05-09T16:46:40.685716Z",
        "date_updated": "2017-05-09T16:46:40.685716Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
    "status": "started",
    "signer_info": {
        "email": "miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee",
        "transaction_access_link": "",
        "link_expired": true
    },
        "cosigner_info": {
            "first_name": "Sam",
            "last_name": "Pepper"
    },
    "require_secondary_photo_id": false
}

Delete cosigner information

curl https://api.notarize.com/v1/transactions/<TRANSACTION_ID> \
  -H "ApiKey: test_key_1234"\
  -H 'Content-Type: application/json' \
  -d \
'
{
    "cosigner": nil,
    "suppress_email":true,
    "draft": true
}
'

Response

{
    "id": "ot_bd5j5n9",
    "date_created": "2017-05-09T16:46:39.823232Z",
    "date_updated": "2017-05-09T16:46:39.823232Z",
    "transaction_name": "Miguels MultiDocument notarization for Leeroy",
    "transaction_type": "Power of Attorney",
    "message_to_signer": "Please notarize these Documents",
    "message_signature": "Thanks, Leeroy.",
    "documents": [{
        "id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
        "date_created": "2017-05-09T16:46:39.767123Z",
        "date_updated": "2017-05-09T16:46:39.767123Z",
        "document_name": "pdf.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 0
    }, {
        "id": "do_d0e14332-bc40-493d-b710-48719bf077b5",
        "date_created": "2017-05-09T16:46:40.685716Z",
        "date_updated": "2017-05-09T16:46:40.685716Z",
        "document_name": "pdf-sample.pdf",
        "allowed_actions": ["NOTARIZATION_REQUIRED"],
        "bundle_position": 1
    }],
    "status": "started",
    "signer_info": {
        "email": "miguel.lee@notarize.com",
        "first_name": "Miguel",
        "last_name": "Lee",
        "transaction_access_link": "",
        "link_expired": true
    },
    "require_secondary_photo_id": false
}

This endpoint can be used to modify various attributes on the transaction, if the transaction is still in “Draft” mode (i.e., Transaction status is started). Attributes that can be modified include the transaction attributes, the signer information and document order.

ARGUMENTS

name description
documents
optional
multi-document feature
An array of documents_order objects. A minimum of at least two of the document_order objects to be specified. The document ids contained in the object should match an existing document id and the bundle position specified should override an existing position.
signer
optional
A signer_info object. All the fields in the signer_info object are optional.
cosigner
optional
two-signer feature
A cosigner object. Set to nil to delete the set cosigner, otherwise set the attribute to be modified.
expiry
optional
expiration feature
ISO-8061 formatted DateTime String, optionally including the timezone offset. If timezone offset is not provided, the accounts default timezone settings will be applied. This param updates the expiration time on the transaction.
transaction_type
optional
Short, human-readable description of the transaction. Can be used to categorize transactions by their purpose or by general type — e.g. Account Opening or Power of Attorney.
transaction_name
optional
Short, human-readable name for the transaction - eg. Miguel's TPS notarization for Leeroy. Defaults to Untitled Transaction.
message_to_signer
optional
Message to signer. Can be used to provide instructions, thank customers, add additional context to the transaction, or simply to add a personal touch. Plain text only. The message will be added to the email sent to the signer.
message_signature
optional
A message signature to append to message_to_signer.
require_secondary_photo_id
optional
defaults to false
Certain businesses and transaction types may need signers to provide two forms of photo identification. This feature enables you to require two forms on a transaction. If true, the signer cannot proceed to the notary meeting without first providing two forms of photo ID during the Notarize identity verification process. If false (default), the signer can proceed to notary meeting after providing one form of photo ID.
draft
optional
Setting to false will trigger the notarization flow.
suppress_email
optional
When set to true, Notarize does not send a notification email to the signer when the transaction is activated. If you use this feature, you are responsible for providing the signer with the transaction_access_link.

RETURNS

Returns a transaction object if the command is successful.

Documents

The Documents endpoints allows you to add, modify and delete documents associated with a transaction. The multi-document feature needs to be enabled for this endpoint. multi-document feature

Add a Document

This method will add a document to a transaction if the transaction is still in Draft state.

POST /v1/transactions/:id/documents HTTP/1.1

Add a document

curl https://api.notarize.com/v1/transactions/:id/documents \
  -H "ApiKey: test_key_1234"\
  -F "document=@path/to/your/document.pdf" \
  -F "customer_can_annotate=true"
  -F "notarization_required=false"

Response

{
    "id": "do_29f983a4-8485-4afb-8343-95996f75c2d5",
    "date_created": "2017-05-10T13:10:20.702098Z",
    "date_updated": "2017-05-10T13:10:20.702098Z",
    "document_name": "document.pdf",
    "allowed_actions": ["CUSTOMER_CAN_ANNOTATE"],
    "bundle_position": 1
}

ARGUMENTS

name description
id
required
Transaction id
document
required
URL to the document
customer_can_annotate
optional
defaults to false
Boolean flag indicating whether the customer can annotate. If true, the signer may add annotations to the document before the notary meeting. If false, the document is presented in view-only mode before the notary meeting.
notarization_required
optional
defaults to true
Boolean flag indicating whether the document requires notarization. If false, the document may still be e-signed in the notary meeting. At least one document in a multi-document transaction must require notarization.

Update a Document

This method will update document attributes if the transaction it is associated with is still in Draft (ie state of Transaction is started).

PUT /v1/documents/{DOCUMENT_ID} HTTP/1.1

Update an existing Document

curl -X "PUT" https://api.notarize.com/v1/documents/do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934 \
  -H "ApiKey: test_key_1234"\
  -F "name=newDocName" \
  -F "customer_can_annotate=true"
  -F "notarization_required=false"

Response

{
    "id": "do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934",
    "date_created": "2017-05-10T13:10:20.702098Z",
    "date_updated": "2017-05-10T13:16:20.900473Z",
    "document_name": "newDocName.pdf",
    "allowed_actions": ["CUSTOMER_CAN_ANNOTATE"],
    "bundle_position": 1
}

ARGUMENTS

name description
id
required
Document id of the document being modified
name
optional
Modified document name
customer_can_annotate
optional
defaults to false
Boolean flag indicating whether the customer can annotate. If true, the signer may add annotations to the document before the notary meeting. If false, the document is presented in view-only mode before the notary meeting.
notarization_required
optional
Boolean flag indicating whether the document requires notarization. If false, the document may still be e-signed in the notary meeting. At least one document in a multi-document transaction must require notarization.

RETURNS

Returns a 200 with the updated transaction object if the update was successful.

Delete a Document

This method will delete an existing document if the transaction it is associated with is still in Draft (ie Transaction state is ‘started’).

DELETE /v1/documents/{DOCUMENT_ID} HTTP/1.1

Delete a document from an existing transaction

curl -X "DELETE" https://api.notarize.com/v1/documents/do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934 \
  -H "ApiKey: test_key_1234"

Response

{
  "message": "Deleted document do_c7e0e599-5e94-4ac1-a4a3-7e09f9994934"
}

ARGUMENTS

name description
id
required
Document id of the document being deleted.

RETURNS

Returns a 200 with a message if the deletion was successful.

Notarization Records

The notarization_record object

{
  "id": "me_rnykzyn",
  "meeting_start": "2016-10-01T18:52:44.725Z",
  "meeting_end": "2016-10-01T18:58:54.245Z",
  "notary_name": "Leeroy Jenkins",
  "notary_registration": "1337",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee"
  },
  "notarized_documents": [
    {
      "notarial_acts": [
        "copy_certification",
        "acknowledgement"
      ],
      "document_url": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/document.pdf?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
    }
  ],
  "verification_credentials": {
    "retrieval_id": "CTJHT32H",
    "retrieval_pin": "7RNTNN",
    "last_name": "Lee",
    "date_completed": "10/19/2016"
  },
  "signer_photo_identification": {
    "primary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_front.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
    "primary_back": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
    "secondary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
  }
}

ATTRIBUTES

name description
id
string
meeting_start
string
Date the notary meeting started, in ISO-8601 format.
meeting_end
string
Date the notary meeting ended, in ISO-8601 format.
notary_name
string
The name of the notary agent who conducted the notary meeting.
notary_registration
string
The registration number of the notary agent who conducted the notary meeting.
signer_info
object
A signer_info object with information given by the signer. This may differ from the signer_info attached to a transaction eg. the user used a different spelling of their name.
notarized_documents
array of object
An array of notarized_document objects.
verification_credentials
object
A verification_credentials object.
signer_photo_identification
object
A signer_photo_identification_object. Only returned for partners with this feature enabled. Please contact us for more information.

The notarized_document object

  {
    "notarial_acts": [
      "copy_certification",
      "acknowledgement"
    ],
    "document_url": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/document.pdf?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
  }

ATTRIBUTES

name description
notarial_acts
array of string
The notarial act performed during the notary meeting on this document. Specified by notary. A single document can have multiple notarial acts. Possible notarial acts are: acknowledgement, copy_certification, verification_of_fact, oath_affirmation, jurat.
document_url
string
A signed S3 link of the notarized document.

The verification_credentials object

{
  "retrieval_id": "CTJHT32H",
  "retrieval_pin": "7RNTNN",
  "last_name": "Lee",
  "date_completed": "10/19/2016"
}

The verification_credentials object holds all the information required for anyone to verify the notarized document at Notarize’s Verification Portal.

This information may be useful to include in transactional emails that your service sends to relying parties, or for display in a secure dashboard or other internal systems. You should be selective and careful about who can access the information since it can be used to retrieve the notarized document as well as personal information of the signer.

ATTRIBUTES

name description
retrieval_id
string
Document ID in the verification portal.
retrieval_pin
string
Document PIN in the verification portal.
last_name
string
The signer’s last name.
date_completed
string
Date of notarization.

The signer_photo_identification object

The signer_photo_identification object is only returned with a notarization_record for partners with this feature enabled. Please contact us for more information.

  {
    "primary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_front.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
    "primary_back": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
    "secondary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
  }

ATTRIBUTES

name description
primary_front
string
A signed S3 link of the front of the signer’s primary photo identification.
primary_back
string
A signed S3 link of the back of the signer’s primary photo identification.
secondary_front
string
A signed S3 link of the front of the signer’s secondary photo identification. Only returned if a secondary form of identification was captured.

Retrieve a notarization_record

GET /v1/notarization_records/{NOTARIZATION_RECORD_ID} HTTP/1.1

Retrieve a notarization record

curl https://api.notarize.com/v1/notarization_records/me_rnykzyn \
  -H "ApiKey: test_key_1234"\

Response

{
  "id": "me_rnykzyn",
  "meeting_start": "2016-10-01T18:52:44.725Z",
  "meeting_end": "2016-10-01T18:58:54.245Z",
  "notary_name": "Leeroy Jenkins",
  "notary_registration": "1337",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee"
  },
  "notarized_documents": [
    {
      "notarial_acts": [
        "jurat",
        "verification_of_fact"
      ],
      "document_url": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/document.pdf?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
    }
  ],
  "verification_credentials": {
    "retrieval_id": "CTJHT32H",
    "retrieval_pin": "7RNTNN",
    "last_name": "Lee",
    "date_completed": "10/19/2016"
  },
  "signer_photo_identification": {
    "primary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_front.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
    "primary_back": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D",
    "secondary_front": "https://s3-us-west-2.amazonaws.com/assets.notarize.com/primary_back.png?AWSAccessKeyId=AKIAJVT3IPSNH662QU6A&Expires=1449430428&Signature=j%2FTzUuHJkrlbAJZGNpCm3xfxgmE%3D"
  }
}

Retrieves the notarization_record with a given ID. You need to supply the unique notarization_record ID that is returned in a transaction object.

ARGUMENTS

name description
id
required
The identifier of the notarization_record to be retrieved.

RETURNS

Returns a notarization_record object if a valid identifier was provided.

Webhooks

Webhooks allow your application to be notified of changes in a transaction’s state rather than requesting the state from the API directly.

Webhook Request Body

Webhook Body

{
  "event": "transaction_status_update",
  "data": {
    "transaction_id": "ot_wd3y67d",
    "status": "received"
  }
}

The POST request sent from Notarize contains a JSON body that describes the event and data relevant to the event.

JSON Body

name description
event
string
Specifies the type of webhook event. Only transaction_status_update exists today.
data
string
Data for this event type.

Data for Transaction Status Updates

name description
transaction_id
string
ID representing the transaction object for this event.
status
string
One of the status values of a transaction object.

Security

Compute the signature

echo -n "{RESPONSE_BODY}" | openssl dgst -sha256 -hmac "{API_KEY}"

Webhook messages are signed so your application can verify that the sender is Notarize. Webhook requests contain an X-Notarize-Signature header with a hexadecimal HMAC signature of the request body, using your API key as the key and SHA256 as the hash function.

You can verify the authenticity of the webhook by computing the signature with your API key and request body, and comparing it to the value in the X-Notarize-Signature header.

Errors and Retry Strategy

The webhook expects the receiver to respond with a 200 response code. If for some reason Notarize cannot reach the webhook URL or your application responds with any response code other than 200, Notarize will retry to make the request with an exponential backoff.

EXPONENTIAL BACK-OFF

Requests that are retried for any reason use an exponential back-off algorithm that will make up to 9 attempts. This means we will attempt to request your webhook URL up to 9 times across roughly one day.

Note that webhooks can be sent more than once and delivery is not guaranteed to be in order. The expected behavior is for your application to manage the state and skip to the latest status.

Set or update your webhook URL

POST /v1/webhooks HTTP/1.1

Set your webhook URL

curl https://api.notarize.com/v1/webhooks \
  -H "ApiKey: test_key_1234"\
  -d "url=https://www.myapp.com/notarize_webhooks"
{
  "url": "https://www.yourapp.com/notarize_webhooks"
}

Set your webhook URL. If a webhook URL has already been set, it will be overridden. The new URL will be used to notify your application of state changes in any and all of your transactions.

ARGUMENTS

name description
url Notarize will make a POST request to this URL for every transaction status change.

Retrieve your webhook URL

GET /v1/webhooks HTTP/1.1

Retrieve your webhook URL

curl https://api.notarize.com/v1/webhooks \
  -H "ApiKey: test_key_1234"
{
  "url": "https://www.yourapp.com/notarize_webhooks"
}

RETURNS

name description
url Notarize will make a POST request to this URL for every transaction status change.

Delete your webhook settings

DELETE /v1/webhooks HTTP/1.1

Delete your webhook URL

curl https://api.notarize.com/v1/webhooks \
  -X "DELETE"\
  -H "ApiKey: test_key_1234"

Returns 200 if successful.

Appendix

The transaction object

Completed Transaction

{
  "id": "ot_anpr8qn",
  "date_created": "2016-10-01T18:52:44.725Z",
  "date_updated": "2016-10-02T20:13:54.245Z",
  "signer_info": {
    "email": "miguel.lee@notarize.com",
    "first_name": "Miguel",
    "last_name": "Lee",
    "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com"
  },
  "documents": [{
          "id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
          "date_created": "2017-05-09T16:46:39.767123Z",
          "date_updated": "2017-05-09T16:46:39.767123Z",
          "document_name": "pdf.pdf",
          "allowed_actions": ["NOTARIZATION_REQUIRED"],
          "bundle_position": 0
      }, {
          "id": "do_d0e14332-bc40-493d-b710-48719bf077b5",
          "date_created": "2017-05-09T16:46:40.685716Z",
          "date_updated": "2017-05-09T16:46:40.685716Z",
          "document_name": "pdf-sample.pdf",
          "allowed_actions": ["NOTARIZATION_REQUIRED"],
          "bundle_position": 1
      }],
  "transaction_name": "Miguel's TPS notarization for Leeroy",
  "transaction_type": "Power of Attorney",
  "message_to_signer": "Please notarize your TPS Report.",
  "message_signature": "Love, Leeroy.",
  "status": "completed",
  "notarization_record": "me_rnykzyn",
  "require_secondary_photo_id": true
}

ATTRIBUTES

name description
id
string
date_created
string
Date this transaction was created, in ISO-8601 format.
date_updated
string
Date this transaction was updated, in ISO-8601 format.
signer_info
object
A signer_info object which only includes information that you set when creating the transaction.
cosigner_info
object
cosigner feature
A cosigner_info object which inlcudes the cosigner information set when creating the transaction.
expiry
optional
expiry feature
An ISO-8061 formatted DateTime String, optionally including the timezone offset. If timezone offset is not provided, the accounts default timezone settings will be applied. This param sets an expiration period on the transaction.
documents
object
multidoc feature
The list of document objects that make up the transaction bundle
external_id
string
A string representing an ID external to Notarize’s systems. Use this to associate a transaction to an ID that your systems understand, such as a User ID. Only returned if external_id was provided during transaction creation.
transaction_type
string
Short, human-readable description of the transaction. Can be used to categorize transactions by their purpose or by general type — e.g. Account Opening or Power of Attorney. Only returned if transaction_type was set when the transaction was created.
transaction_name
string
Short, human-readable name for the transaction - eg. Miguel's TPS notarization for Leeroy. Only returned if transaction_name was set when the transaction was created.
message_to_signer
string
Message to signer. Can be used to provide instructions, thank customers, add additional context to the transaction, or simply to add a personal touch. Plain text only. The message will be added to the email sent to the signer. Only returned if a message_to_signer was provided during transaction creation.
message_signature
string
A message signature to append to message_to_signer. Only returned if a message_signature was provided during transaction creation.
status
string
Set to one of the status values.
notarization_record
string
An ID to retrieve the notarization_record for this transaction, including the notarized document. Only returned if the transaction’s status is completed.
require_secondary_photo_id
boolean
When true, the signer cannot proceed to a notary meeting without providing two forms of photo ID for verification. When false, only one form of photo ID is required.

The document object

Document Object

{
    "id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
    "date_created": "2017-05-09T16:46:39.767123Z",
    "date_updated": "2017-05-09T16:46:39.767123Z",
    "document_name": "pdf.pdf",
    "allowed_actions": ["NOTARIZATION_REQUIRED"],
    "bundle_position": 0
}

ATTRIBUTES

name description
id
string
date_created
string
Date this document was created, in ISO-8601 format.
date_updated
string
Date this document was updated, in ISO-8601 format.
document_name
string
Name of the document
allowed_actions
array
Possible values are CUSTOMER_CAN_ANNOTATE and NOTARIZATION_REQUIRED
bundle_position
int
0 indexed position of the document within the bundle

The document_order object

Specifies the position of a document within a document bundle

Document Order Object

{
    "document_id": "do_0004af63-7b4e-422d-93d2-4f053dea39c2",
    "bundle_position": 0
}

ATTRIBUTES

name description
document_id
string
Document id
bundle_position
int
0 indexed position of the document within the bundle.

The signer object

{
  "email": "miguel.lee@notarize.com",
  "first_name": "Miguel",
  "last_name": "Lee"
}

Object passed in when creating or updating a transaction object.

ARGUMENTS

name description
email
string
optional
Email
first_name
string
optional
First Name
last_name
string
optional
Last Name

The signer_info object

{
  "email": "miguel.lee@notarize.com",
  "first_name": "Miguel",
  "last_name": "Lee",
  "transaction_access_link": "https://app.notarize.com/activate-transaction?bundle_id=some-bundle-id&code=some-code&email=some@email.com",
  "dob": "1996-05-19",
  "address": {
    "line1": "1005 Langley Street",
    "line2": "Apt. 101",
    "city": "Victoria",
    "state": "CA",
    "postal": "91210",
    "country": "US"
  }
}

Returned as part of the notarization and transaction record.

In the context of a transaction, the signer_info object will only contain information provided by you during the creation of the transaction. In the context of a notarization_record, the signer_info object will contain the information provided by the singer.

ATTRIBUTES

name description
first_name
string
First Name
last_name
string
Last Name
email
string
Email
transaction_access_link
url
Link to the transaction
dob
string
Date of Birth
address
adddress json object
Address Information

The cosigner object

{
  "first_name": "Joe",
  "last_name": "Bernstein"
}

Object passed in when creating or updating a transaction object.

ARGUMENTS

name description
first_name
string
optional
First Name
last_name
string
optional
Last Name

The cosigner_info object

Returned as part of the transaction object

{
  "email": "malvina@hoppe.co",
  "first_name": "Pamela",
  "last_name": "Leonie",
  "dob": "1996-05-19",
  "address": {
    "line1": "1005 Langley Street",
    "line2": "Apt. 101",
    "city": "Victoria",
    "state": "CA",
    "postal": "91210",
    "country": "US"
  }
}

In the context of a transaction, the cosigner_info object will only contain information provided by you during the creation of the transaction. In the context of a notarization_record, the cosigner_info object will contain the information provided by the cosigner.

ATTRIBUTES

name description
first_name
string
First Name
last_name
string
Last Name
email
string
Email
dob
string
Date of Birth
address
adddress json object
Address Information