v1
latestOpenAPI 3.0.12026-07-269671357.0 KBAdd Document
Path parameters
ID of the Transaction to add the document to.
Query parameters
Control documents and signer photo identifications download URLs. v1 for AWS S3 pre-signed URLs. v2 for Proof secure URLs.
Request body
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.
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.
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 requiring notarization in the transaction also use identity confirmation as the requirement to avoid requiring KBA on the transaction. Read more about document requirements.
Position to put document in bundle
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.
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.
Boolean flag indicating whether the document is a bookmarked PDF. If passed true the document will be split by bookmark into multiple documents.
External tracking identifier such as a UUID string that can be useful for mapping documents back to your own system.
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
{
"document": "https://fakecloudstorage/one_page.pdf",
"notarization_required": true,
"witness_required": true
}Response
successful
List of allowed actions on document.
Position to put document in bundle
base64 encoded document. Present if base64 encoding was specified in request. Currently supported for get_document only.
Date document was created/uploaded.
Date document was last updated.
Name of document.
Boolean flag indicating whether the document requires esigning.
Boolean flag indicating whether the document requires identity confirmation.
Boolean flag indicating whether the document is an eNote.
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.
Error message if document processing failed.
State of document processing.
Anecdote for document rejection.
Reason for document rejection.
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 URL for the final document PDF.
The external tracking ID of the document.