Sign in

v1

latestOpenAPI 3.0.12026-07-269671357.0 KB
Documents

Update Documents

put/mortgage/v2/documents/{id}

Path parameters

idstring required

ID of the document to update.

Query parameters

document_url_version'v1' | 'v2'

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

Request body

namestring

Modified document name.

tracking_idstring

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

requirementstring

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_annotateboolean

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_requiredboolean

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_requiredboolean

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_requiredboolean

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_headerstring

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

Example request

{
  "name": "new-name1",
  "customer_can_annotate": "true",
  "witness_required": "true",
  "notarization_required": "true",
  "tracking_id": "tracking_id"
}

Response

successful

idstring
allowed_actionsstring[]

List of allowed actions on document.

bundle_positioninteger

Position to put document in bundle

completion_statestring
datastring nullable

base64 encoded document. Present if base64 encoding was specified in request. Currently supported for get_document only.

date_createdstring

Date document was created/uploaded.

date_updatedstring

Date document was last updated.

document_namestring

Name of document.

esign_requiredboolean

Boolean flag indicating whether the document requires esigning.

final_document_urlstring nullable
identity_confirmation_requiredboolean

Boolean flag indicating whether the document requires identity confirmation.

is_enoteboolean

Boolean flag indicating whether the document is an eNote.

notarization_requiredboolean

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.

permissionsstring[]
processing_errorstring nullable

Error message if document processing failed.

processing_statestring nullable

State of document processing.

rejection_anecdotestring nullable

Anecdote for document rejection.

rejection_reasonstring nullable

Reason for document rejection.

requirementstring

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.

signed_urlstring nullable

Signed URL for the final document PDF.

signing_typestring
tracking_idstring nullable

The external tracking ID of the document.