GuidesAPI ReferenceDiscussions
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Creating a Document Package

Suggest Edits

Blend provides lenders the ability to create document packages for consumer(s) to view and sign. These packages can be used for disclosures, or any other sort of documents that need to be viewed or signed.

This guide will walk you through how to create a package in Blend. It should be noted that before you can create a package you need your loan and recipients to already be in Blend. For more information on how to do this please see Create a New Home Lending Application.

We will start by going over the different components of a package, and end with an example POST.

Package Types

Blend supports a number of package types. For the most part these package types only affect the text a recipient sees on any emails and tasks. Any exceptions to this will be called out below.

Disclosures Package Types

  • INITIAL_LOAN_ESTIMATE
  • REVISED_LOAN_ESTIMATE
  • CLOSING_DISCLOSURE
  • REVISED_CLOSING_DISCLOSURE
  • OTHER_DISCLOSURE

The OTHER_DISCLOSURE type does not include very helpful text for the recipient by itself. Instead it is recommended that you provide a name and description when creating the package. A POST using the other package types will ignore any values passed in for name and description.

Document Package Types

  • DOCUMENT_PACKAGE

The DOCUMENT_PACKAGE type does not include very helpful text for the recipient by itself. Instead it is recommended that you provide a name and description when creating the package.

This type also allows the caller to set the dueDate field. This will show the recipient when the lender would like the package completed by. All this field does is show the date to the borrower in their task, there is no logic behind this field.

Package Envelopes

When creating a package you must define what envelopes you want. An envelope defines how you want the recipients to interact with the documents. This includes things such as tasks and tracking data. Blend tracks each envelope on a package. This allows you to understand exactly what each recipient has done. Each package must consist of one or more envelopes, but you can only have one of each envelope type per package.

ESIGN

An esign envelope is used when you need the recipients to electronically sign documents. This will create a task that redirects the recipient into Blend's esign provider.

REVIEW

A review envelope is used when you need the recipients to electronically view documents. This will create a task that presents the documents to the recipient in Blend's document viewer.

WETSIGN

A wetsign envelope is used when you need the recipients to download, print, sign, and upload documents. This will create a task that requires the recipient to download the document, then upload their signed copy.

Recipients

Packages support three different types of signers.

  • Borrowers
  • Third Party Recipients (e.g., Non-borrowing owners/spouses, non-obligors, etc.)
  • Lender

Borrowers

Any borrower on an application can be a recipient for a package. In order to get partyIds you can call GET application parties.

Third Party Recipients

Any Third Party Recipients on an application can be a recipient on a package. In order to get partyIds you can call GET application parties.

Lender

You can require a lender to be the signer for an esign envelope on a package. When having a lender be a signer you must set the partyId to LENDER. Only the lender user assigned as the loan originator can complete the signing task.

Documents

After you add recipients to an envelope you will need to say what documents they are supposed to interact with. In order to add a document to a recipient on an envelope you will need to first add the document to Blend.

Adding a Document to Blend

In order to add the document to Blend you need to use POST /documents. When posting a document for a package you need to ensure the following three fields are properly set.

  • partyIds Must contain a list of recipient Ids that should be able to see the document.
  • shareWithAllParties Must be set to true.
  • status Must be set to SIGNATURE_REQUESTED.

The partyIds and shareWithAllParties fields ensure the recipients have the correct document permissions to view and sign. The status is needed for the document to be marked for export.

Adding a Document to a Recipient

Once you have the Blend documentId you can add this to the recipient metadata object on the envelope. For wetsign and review envelopes you just need to add the documentId. For esign envelopes you will need to also add any tabs the recipient is required to complete.

Blend supports the following tabs:

  • Approve
  • Sign
  • Initial
  • Checkbox
  • Text
  • Notes
  • List
  • Radio Group

Example Posts

Below are some examples for posting a package. Please see POST /packages for the API schema.

{
  "type": "OTHER_DISCLOSURE",
  "name": "Flood Disclosure",
  "description": "You live on a flood plain",
  "foreignPackageId": "8bd52843-039a-4632-a86b-edec18737003",
  "applicationId": "84080c03-668c-4184-8090-df2a57ccfb1f",
  "envelopes": [
    {
      "providerType": "ESIGN",
      "recipients": [
        {
          "partyId": "LENDER",
          "metadata": {
            "documents": [
              {
                "documentId": "540acbc9-dbda-4db2-b953-fd4721c22144",
                "tabs": [
                  {
                    "type": "signHere",
                    "attributes": {
                      "xPosition": 0,
                      "yPosition": 0,
                      "pageNumber": 1,
                      "scaleValue": 1
                    }
                  }
                ]
              }
            ]
          }
        },  
        {
          "partyId": "52a5a76e-cffa-4a7b-af6b-855a1d1abf80",
          "metadata": {
            "documents": [
              {
                "documentId": "540acbc9-dbda-4db2-b953-fd4721c22144",
                "tabs": [
                  {
                    "type": "signHere",
                    "attributes": {
                      "xPosition": 0,
                      "yPosition": 0,
                      "pageNumber": 1,
                      "scaleValue": 1
                    }
                  }
                ]
              },
              {
                "documentId": "2fc03250-0567-4b27-819c-0a2ff3ef7300",
                "tabs": []
              }
            ]
          }
        }
      ]
    }
  ]
}

{
  "type": "OTHER_DISCLOSURE",
  "name": "Flood Disclosure",
  "description": "You live on a flood plain",
  "foreignPackageId": "03940051-b99c-46d2-b2dd-a20e4c2ca705",
  "applicationId": "84080c03-668c-4184-8090-df2a57ccfb1f",
  "envelopes": [
    {
      "providerType": "WETSIGN",
      "recipients": [
        {
          "partyId": "52a5a76e-cffa-4a7b-af6b-855a1d1abf80",
          "metadata": {
            "documentIds": [
              "712733f3-f3db-4d6f-9e27-1c956053a317"
            ]
          }
        }
      ]
    },
    {
      "providerType": "REVIEW",
      "recipients": [
        {
          "partyId": "52a5a76e-cffa-4a7b-af6b-855a1d1abf80",
          "metadata": {
            "documents": [
              {
               "documentId": "3a109171-cd40-45d1-aec7-e067a413369f"
              }
            ]
          }
        }
      ]
    }
  ]
}

Updated over 2 years ago