Add eNote

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This method will add an eNote document to a transaction if the transaction is in the “started” state.

An eNote can be added to a transaction in one of two ways. Either full eNote can be added, or an eNote schema file (in accordance with the schema definition found here) can be added which Proof then uses to generate a full eNote.

The Proof for Mortgage API accepts two eNote file types when creating an eNote document.

We are able to create an eNote Document from:

  1. MISMO SMART_DOCUMENT XML (eNote XML). An example of this can be found here.
    These SmartDocs are based on the SmartDoc Template XML (the XML Schema Definition can be found here)

  2. We are also able to create an eNote from a "seed" XML file. Proof will use this file to generate a MISMO SmartDoc. An example of a seed file for a two signer transaction can be found here.

Path Params
string
required

Returned in the create transaction call.

Body Params
string
length ≤ 5000

Required unless type is EORIGINAL_CONTAINER. An eNote document supplied as a URL or local file encoded as a Base64 string. If type is set, must be an encoded XML file or a URL pointing to an XML. If integration is set, must be a URL pointing to a PDF

string
enum

Required unless integration is set. The type of eNote to be added.

Allowed:
string
enum

Required unless type is set. The integration source of the eNote.

Allowed:
borrowers
array of objects
borrowers
container
object

Required if type is EORIGINAL_CONTAINER

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json