Business Transaction Quickstart

Our REST API is designed to have predictable, resource-oriented URLs. Webhooks are also available to ping your systems when a transaction changes state.

To get started with a Proof account, see our pricing page, or contact [email protected] if you have any questions about your account.

1. Generate your API key.

See our guides on API Keys for more info.

2. Create Transaction

The minimum required parameters to create a Business transaction via the Create Transaction endpoint are

1. The signer's email address
2. A document and requirement for that document

JSON

POST /transactions/

{
  "signers": [
    {
      "email": "[email protected]"
    }
  ],
  "documents": [
      {
          "resource": "https://static.notarize.com/Example.pdf",
          "requirement": "notarization"
      }
  ]
}

Alternatively, you can create the transaction as a draft, and then update it or add documents later:

JSON

POST /transactions

{
  "signers": [
    {
      "email": "[email protected]"
    }
  ],
  "draft": true
}

3. 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 are welcome to use this static test document for testing purposes: https://static.notarize.com/Example.pdf.

JSON

POST /transactions/ot_xxxxxxx/documents

{
    "resource": "https://static.notarize.com/Example.pdf"
}

4. Monitoring the Transaction

You can leverage Proof webhooks to monitor the state of the transaction. Webhook events only contain the event name and the transaction ID, so more detailed monitoring will require a Retrieve Transaction call.

5. Retrieve the Completed Transaction

The Retrieve Transaction endpoint will return links to the completed documents. If you're interested in running a test end-to-end with a test notary session, see our testing guide.