Add Document

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This method will add a document to a transaction if the transaction is still in the draft state (i.e. transaction status is started).

Returns

Returns a document object if successful.

Path Params

string

required

ID of the Transaction to add the document to.

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

filename

string

length ≤ 5000

Plain language name given to the document. If this parameter is not provided, Proof will automatically assign a name using the end of the page path of the resource URL.

resource

string

length ≤ 42000000

The document file resource. Accepted values can be a URL pointing to the PDF file, the full contents of the PDF file in Base64 encoding, the file itself as a direct upload, or a template permalink string pointing to a preconfigured PDF. The maximum accepted file size is 30MB.

document

string

requirement

string

length ≤ 5000

Completion requirement for the document. Accepted values can be notarization, esign, identity_confirmation (identity confirmation feature), readonly, and non_essential. Completion requirement for the document. If the value is set to non_essential, the document will be hidden from signers before the notary meeting and values for customer_can_annotate and witness_required will be ignored and set to false. identity_confirmation is used to support signing of PS Form 1583 for signers without a US SSN. Note: if identity_confirmation is set as the document requirement, ensure that all documents requiring notarization in the transaction also use identity confirmation as the requirement to avoid requiring KBA on the transaction. Read more about document requirements.

notarization_required

boolean

witness_required

boolean

Boolean flag indicating whether an additional witness must be present for this document's signing. A witness is a third person, in addition to the signer and the notary, who must be physically located with the signer.

bundle_position

integer

Position to put document in bundle

esign_required

boolean

identity_confirmation_required

boolean

signing_requires_meeting

boolean

vaulted

boolean

Boolean flag indicating whether the authoritative copy of the document should be stored in an eVault upon transaction completion. Defaults to false, indicating that the authoritative copy of the document will be accessible to both the signer and users in your Proof business account. If passed true, the authoritative copy will be stored in the eVault associated with this account; signers and business users will only be able to access a watermarked copy.

authorization_header

string

length ≤ 5000

Used to fetch doc URLs. Value passed should be in the form of a key-value pair with format "header_name:header_value"

customer_can_annotate

boolean

Boolean flag indicating whether a signer can add their own annotations onto the document. Defaults to false, limiting the signer to only filling out designated fields setup on the document or as directed by a notary.

pdf_bookmarked

boolean

Boolean flag indicating whether the document is a bookmarked PDF. If passed true, the document will be split by bookmark into multiple documents.

tracking_id

string

length ≤ 5000

External tracking identifier such as a UUID string that can be useful for mapping documents back to your own system.

text_tag_syntax

string

length ≤ 5000

Syntax used by text tags within the document.

signing_designations

array of objects

This array contains a prescribed list of designations for signers and/or a notary to annotate the document.

signing_designations

signing_designation_groups

array of objects

This array contains a prescribed list of designations for signers and/or a notary to annotate the document.

signing_designation_groups

Responses

Returns

200successful

400Bad Request

422Unprocessable Entity