Update Documents

put

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This method will update a document in a 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 document 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

name

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.

document_url_version

boolean

enum

Optional param to test v2 document urls.

Allowed:

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.

identity_confirmation_required

boolean

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.

Responses

Returns

200successful

400Bad Request