Disclosures Recipient Envelopes
Note: Only ESIGN, WETSIGN, REVIEW providerTypes below. Adding other provider types at later date (12/15/20)
When creating a disclosures package (https://developers.blend.com/blend/reference#post-a-package), there are multiple ways to provide documents to recipients. For some documents, recipients need to electronically view and sign while others require the recipient to physically sign and re-upload.
When a package is created via POST or retrieved via GET, the envelope associated with the package will contain the recipients and (if applicable) the documents that recipients need to take action on. To determine the kind of envelope will be submitted to the recipient, the providerType can be used.
Envelope Metadata
For each different kind of envelope created for a package, the contents of the metadata in the envelope will follow a different schema. Below is the envelope schema response for both https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package.
{
// ...Rest of GET /package fields
envelopes: [
{
id: string
providerId: string
signatureRequired: boolean
status: 'HAS_NOT_VIEWED' | 'VIEWED' | 'SIGNED' | 'COMPLETED' | 'DECLINED'
providerType: "ESIGN" | "WETSIGN" | "DIRECT_LINK" | "SSO_SAML" | "REVIEW" | "REVIEW_AND_SIGN"
recipients: [
{
partyId: string
partyType: 'BORROWER' | 'LENDER' | 'SETTLOR' | 'SPOUSE' | 'TITLE_HOLDER' | 'OTHER
status: 'HAS_NOT_VIEWED' | 'VIEWED' | 'SIGNED' | 'COMPLETED' | 'DECLINED'
metadata: {
// ...Same as the Request Schema metadata below for each corresponding providerType
}
}
]
}
]
}
For more information on what the metadata schema would look like, please scroll down to find the corresponding provider type and its schema.
Provider Types
ESIGN
E-sign envelopes contain documents that need to be electronically viewed and signed through DocuSign.
In order to create an envelope of this type, document IDs and their corresponding tabs are expected to passed in via https://developers.blend.com/blend/reference#post-a-package. That information will be store in the metadata field and then can be retrieved via GET requests (https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package).
{
// ...Rest of POST /packages fields
envelopes: [
{
providerType: "ESIGN" // provider type
recipients: [
{
partyId: string
// Metadata used for ESIGN provider type.
// Same for both POST /packages and GET /packages
metadata: {
loanId: string
documents: [
{
documentId: string
tabs: [
// Example of tabs that may be used
{
type: "approveTabs"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
font?: string
fontColor?: string
fontSize?: string
bold?: boolean
height?: number
width?: number
buttonText?: string
}
},
{
type: "signHereTabs"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
scaleValue?: number
required?: boolean
status?: string
}
},
{
type: "dateSignedTabs"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
font?: string
fontColor?: string
fontSize?: string
bold?: boolean
value?: string
}
},
{
type: "checkboxTabs"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
selected?: boolean
}
},
{
type: "textTabs"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
font?: string
fontColor?: string
fontSize?: string
bold?: boolean
required?: boolean
height?: number
width?: number
maxLength?: number
}
},
{
type: "list"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
value?: string
}
},
{
type: "radioGroupTabs"
attributes: {
groupName?: string
radios: [
{
tabId?: string
xPosition: number
yPosition: number
pageNumber: number
value?: string
selected?: boolean
required?: boolean
}
]
}
},
{
type: "initialHere"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
scaleValue?: number
required?: boolean
}
},
{
type: "date"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
font?: string
fontColor?: string
fontSize?: string
bold?: boolean
required?: boolean
}
},
{
type: "note"
attributes: {
xPosition: number
yPosition: number
pageNumber: number
tabLabel?: string
name?: string
conditionalParentLabel?: string
conditionalParentValue?: string
font?: string
fontColor?: string
fontSize?: string
bold?: boolean
height?: number
width?: number
value?: string
}
}
]
}
]
}
}
]
}
]
}
WETSIGN
Wet-sign envelopes contain documents that recipients need to physically sign and then re-upload.
Similar to other envelopes, the WETSIGN envelope contains metadata created via https://developers.blend.com/blend/reference#post-a-package and can be retrieved via GET requests (https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package)
{
// ...Rest of POST /packages fields
envelopes: [
{
providerType: "WETSIGN" // provider type
recipients: [
{
partyId: string
// Metadata used for WETSIGN provider type.
// Same for both POST /packages and GET /packages
metadata: {
documentIds: string[]
}
}
]
}
]
}
REVIEW
Review envelopes contain documents for recipients where recipients need to only view electronically.
Similar to other envelopes, the REVIEW envelope contains metadata created via https://developers.blend.com/blend/reference#post-a-package and can be retrieved via GET requests (https://developers.blend.com/blend/reference#retrieve-all-packages-for-an-application and https://developers.blend.com/blend/reference#retrieve-a-package)
{
// ...Rest of POST /packages fields
envelopes: [
{
providerType: "REVIEW" // provider type
recipients: [
{
partyId: string
// Metadata used for REVIEW provider type.
// Same for both POST /packages and GET /packages
metadata: {
documents: [
{
documentId: string
type?: string
name?: string
description?: string
}
]
}
}
]
}
];
}
Updated almost 2 years ago