Update Draft Transaction

put

https://api.proof.com/v1/transactions/{id}

Path Params

string

required

ID of the transaction to update.

Query Params

document_url_version

string

enum

Defaults to v1

Control documents and signer photo identifications download URLs. v1 for AWS S3 pre-signed URLs. v2 for Proof secure URLs.

Allowed:

Body Params

activation_time

string

length ≤ 100

An ISO-8601 formatted DateTime String, optionally including a timezone offset. If timezone offset is not provided, the Proof account’s default timezone settings will be applied. This param sets the time after which the signer is permitted to connect with a notary to complete the transaction. If a signer attempts to connect with a notary before this time is reached, the signer will be only permitted to review documents.

signer

object

documents

array of objects

documents

signers

array of objects

An array of signer objects each with at minimum the email field set (limit 10 signers per transaction). The request to notarize the document will be sent to that email address.

signers

cosigner

object

draft

boolean

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.

expiry

string

length ≤ 100

An ISO-8601 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 time after which the signer is NOT permitted to connect with a notary to complete the transaction. If a signer attempts to complete the transaction after this time is reached, they will receive an error. Expiration time is optional, and no default is set if this parameter is left blank. Any transaction that expires is no longer editable, and a new transaction must be created.

payer

string

enum

Possible values are signer or sender. If no value is supplied then the payer will be based on the api key's payer setting.

Allowed:

external_id

string

length ≤ 5000

A string representing an ID external to Proof's systems. Use this to associate a transaction to an ID that your systems understand, such as an Order ID or system GUID.

transaction_name

string

length ≤ 5000

Short, human-readable name for the transaction - eg. Miguel's TPS notarization for Leeroy. Defaults to Untitled Transaction.

message_to_signer

string

length ≤ 30000

Message to signer using GitHub Flavored Markdown. Html, images, links, and code are stripped out. Can be used to provide instructions, thank customers, add additional context to the transaction, or simply to add a personal touch. The message will be added to the email sent to the signer. (30,000 character limit)

transaction_type

string

length ≤ 5000

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.

message_subject

string

length ≤ 30000

Subject line of email to signer.

message_signature

string

length ≤ 30000

Signature in email to signer.

pdf_bookmarked

boolean

Split the document by bookmarks if it is a pdf

require_secondary_photo_id

boolean

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 Proof identity verification process. If false (default), the signer can proceed to notary meeting after providing one form of photo ID.

suppress_email

boolean

If sent as true during activation, Proof will 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. This value is not stored on the transaction and must be provided anytime the transaction is activated.

authentication_requirement

string

enum

Additional authentication requirement for signers on the transaction. If SMS, a phone number must be provided for each signer.

Allowed:

require_new_signer_verification

boolean

When set to false, Proof will not require a new signer to verify their email address before moving into the transaction flow.

notary_instructions

array of objects

Instructions for the Notarize Network notary.

notary_instructions

redirect

object

notary_id

string

length ≤ 5000

User ID ("us_xxxxxxx") of the assigned Notary. Eligible notaries must be either a connected BYOT notary, or a BYON notary who is a member of your organization. Notary assignment is not a strict requirement. When this parameter is specified, the notary will be sent an SMS that the signer is about to enter the waiting room, but the notary can take any signer in the queue, and any available notary can take the signer.

notary_meeting_time

date-time

length ≤ 100

An ISO-8061 formatted DateTime String, optionally including the timezone offset. Meeting time will be shown to signer in default emails. Proof will not prevent the signer or notary from starting the meeting at any other time.

organization_id

string

length ≤ 5000

The organization id of a child account. If the authenticated account has child accounts, specifying this parameter will create the transaction in the provided child org.

document_url_version

boolean

enum

Optional param to test v2 document urls.

Allowed:

cc_recipient_emails

array of objects

An array of email addresses to CC on the transaction. They will receive notification when it is sent and completed and be able to view the completed documents.

cc_recipient_emails

config_id

string

The ID of the config used for this transaction. This will ensure that the transaction will load as expected in your dashboard if you need to make any edits. Once set this cannot be edited. Available values: ["hybrid_purchase_buyer_loan", "hybrid_refinance", "hybrid_trailing_docs", "identify", "lender_heloc", "lender_loan_mod_borrower", "lender_refinance", "notarization", "other", "purchase_buyer", "purchase_buyer_loan", "purchase_seller", "real_estate_identify", "real_estate_sign", "real_estate_verify", "sign", "title_heloc", "title_loan_mod_borrower", "trailing_docs", "verify"]

Responses

200successful

400Bad Request

403Forbidden

404Not Found

422Unprocessable Entity