Business API quick start guide – Proof Help Center
The Business API quick start guide for Proof explains that eligible organizations can use the RESTful Proof Business API to send documents, create transactions, connect signers for notarization or eSignature workflows, monitor transaction status via webhooks, and retrieve completed documents, while emphasizing secure handling of API keys and OAuth credentials, providing links to detailed API references and instructions for generating API keys within a Proof account.
Before you begin.
Availability: API access is available to eligible organization accounts. Contact your Customer Success Manager (CSM) or Sales representative if API access is not enabled for your organization.
Important: API credentials provide access to your Proof account. Store API keys and OAuth secrets securely, and never share them publicly or through unsecured channels.
The short answer: The Proof Business API lets you send documents to Proof and connect your signer to complete them. This guide outlines the sequence of API calls typically used for an end-to-end Proof integration.
The API is organized around REST, uses predictable resource-oriented URLs, and returns HTTP response codes to indicate errors. Webhooks are available to notify you when a transaction changes state.
For full technical specifications, see the API Endpoint Reference. OAuth client applications are also available as an alternative authentication method.
Common use cases
- Creating Proof transactions from an external platform
- Sending documents to Proof through an integration
- Connecting signers to complete notarization or eSignature workflows
- Monitoring transaction status with webhooks
- Retrieving completed documents through the API
Security considerations
- Store API keys and OAuth secrets in a secure credential management system.
- Never expose credentials in source code repositories or client-side applications.
- Rotate credentials according to your organization’s security policies.
- Use OAuth client applications when your integration requires OAuth-based authentication.
- Delete or revoke unused, exposed, or compromised credentials immediately.
1. Generate your API key
After you create a Proof account, generate your API key from within your account. To generate your key, follow these instructions.
Tip: OAuth client applications are also available for approved organizations that prefer OAuth-based authentication.
2. Decide the transaction parameters
These parameters allow you to customize the transaction for your internal needs and the signer experience. You can set values such as transaction_name, file_number, and message_to_signer. A full list of parameters can be found in the Create Transaction endpoint.
Specifically, we recommend setting the following:
draft_sign: true
3. Create your transaction
Once you've decided on your transaction parameters, make a POST request to the Create Transaction endpoint to create the transaction.
4. Add your documents to the transaction
Proof supports .pdf files supplied as URLs or base64 encoded local files. 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 pass a pdf_bookmarked document, it may take Proof additional time to split it. Proof will respond with a 200 response indicating the document upload is in progress. To set document parameters on a pdf_bookmarked document, wait for the upload to complete, retrieve the document object from the transaction, and use the returned document ID to update the document flags.
A full list of supported document parameters is available in the Add Document to Transaction endpoint. These parameters allow you to set document-level permissions such as notarization_required or witness_required.
5. Monitor the transaction
Use Proof Webhooks to monitor transaction state changes. Several events may be sent, including events for when a signer receives the transaction email, opens the transaction, and completes signing.
6. Retrieve the completed transaction
The Retrieve Transaction endpoint returns links to completed documents. Alternatively, the binary file content for each document can be returned using the Retrieve Document endpoint.
Best practices
- Test API workflows in a non-production environment before live deployment.
- Confirm transaction parameters before sending invitations to signers.
- Use webhooks instead of manual polling whenever possible.
- Validate document-level flags before sending the transaction.
- Securely store credentials and rotate them according to your organization’s policy.
Troubleshooting
- If you cannot create a transaction, confirm your organization has API access enabled and that your credentials are valid.
- If document upload is delayed, check whether the document was submitted with
pdf_bookmarkedset to true. - If webhook events are not received, confirm your webhook endpoint is active, reachable, and configured to accept Proof webhook events.
- If completed documents are unavailable, confirm the transaction has completed before calling the retrieve endpoints.
Summary Checklist
- Generate your API key or configure an OAuth client application.
- Set
draft_sign: truein your transaction parameters. - POST to the Create Transaction endpoint to initialize the transaction.
- Add your PDF documents and set document-level flags, such as
notarization_required. - Set up webhooks to monitor transaction state changes.
- Use the Retrieve Transaction or Retrieve Document endpoint to access completed files.
Still unsure? For full technical specifications, see the API Endpoint Reference, or contact Proof Support for help.
Related
2025-05-12 Proof Release Notes
The May 12, 2025 Proof release introduces OAuth authentication for API users (delayed to May 19), improved Kentucky notary seal formatting, removal of commission expiration from Colorado quick stamps, and a new default fully zoomed-out document preview for signers to enhance document review across all devices.
API Supplement
The API Supplement, effective December 16, 2024, is incorporated into the Proof General Terms and grants Subscribers a limited, revocable license to use Proof’s APIs solely for integrating their applications with Proof’s Services, requires secure handling and non-sharing of API Keys, restricts API use to approved purposes, and governs access to sensitive personal data such as homeowner and financial information under strict compliance conditions.
Create an OAuth Client Application – Proof Help Center
The Proof Help Center guide explains that organization owners, admins, or users with API management permissions can create OAuth client applications—a paid feature enabled by Proof—to securely connect external systems to Proof accounts using token-based authorization instead of passwords, with each client application having a unique App ID, multiple one-time-viewable App secrets, full API key scope, and tokens that expire every two hours, recommending separate clients for different environments and emphasizing secure storage of secrets.
Set Up API Users in Encompass – Proof Help Center
The article guides Encompass administrators through creating an API user with specific permissions—including Read/Edit Loans, Edit Subordinate Loans, and Encompass LO Mobile Connect—to enable Proof's integration using provided API keys, and instructs notifying the Proof Solutions Engineer to complete the connection and receive necessary eClosing forms.
Delete an OAuth Client Application or Secret – Proof Help Center
The Proof Help Center guide explains that only organization owners or admins can immediately delete an OAuth client application or revoke a client secret—actions that disable authentication for all integrations using those credentials—and recommends rotating secrets instead of deleting active applications, providing step-by-step instructions and warnings about the irreversible impact on connected systems.
Salesforce: Set Up API for Testing – Proof Help Center
The article explains how Salesforce administrators or owners can enable testing mode in sandbox or developer environments by activating the "Package Testing Mode" in Custom Settings to use the Proof testing API for validating workflows, transaction creation, webhook behavior, and document retrieval during user acceptance testing before switching to the production API, emphasizing best practices and troubleshooting tips for a smooth integration setup.