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

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.

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.

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

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.

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

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)

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.

Subject line of email to signer.

Signature in email to signer.

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

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.

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.

Documents to be signed or notarized. Accepted as an array of document objects or simple document["resource"] field values. Maximum size of an individual document is 30MB, or approximately 42M characters encoded in base64.

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"]