Update Documents

patch

https://api.proof.com/mortgage/v2/documents/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Modified document name.

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.

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.

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.

notarization_required

boolean

Boolean flag indicating whether the document requires notarization. If true, identity_confirmation_required must be false. If false, the document may still be e-signed in the notary meeting. At least one document in a transaction must require notarization or identity confirmation.

identity_confirmation_required

boolean

Enterprise feature. Boolean flag indicating whether the document requires identity confirmation. If true, notarization_required must be false. At least one document in a transaction must require notarization or identity confirmation.

witness_required

boolean

Boolean flag indicating whether an additional witness must be present. This witness is a third person, in addition to the signer and the notary, who must be physically located with the signer. If true, this witness must be present. If false, no witness is required.

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"

Responses

200successful

400bad request

404Not Found

422Unprocessable Entity