Package Settings for Digital Lending

OneSpan Sign has created an OneSpan Sign Digital Lending Solution that can store chattel paper and other contracts (e.g., loans) in a digital vault.

To instruct OneSpan Sign to vault a contract, integrators must add to the package's data field the registry_data JSON field described below.

Creating a package or template with the REST API always involves certain standard settings — see Signing Ceremony Settings.

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

registry_data

This field should be a Base-64-encoded JSON string. When the field is decoded, the parameters in the following table can be viewed.

Parameter Required? Description
vaults Yes

This is a JSON array that identifies a vault where chattel paper will be stored.

Each entry in the JSON array must contain the following required fields:

  • orgId — Unique ID of the Organization that owns the vault where the chattel paper will be stored. This is the same Organization ID employed by users when they log into the e-Vault Manager Console.

  • vaultId — The numerical ID of the vault where chattel paper will be stored. An Organization Administrator can see this ID by viewing the vault's details in the Organization identified by the orgId.

Each entry in the JSON array may contain the following optional field:

  • transaction — Name to be given to the e-Vault Manager transaction that will be used to register the chattel paper with the e-Vault Manager. The transaction may contain multiple documents.

registryRecords Yes

This is a JSON array that must contain the following required fields. Each entry of the array contains vaulting information for a specific document.

  • documentId — Name of the OneSpan Sign document that will be registered with the e-Vault Manager. This document is typically a loan. The value of this parameter should match the document ID of a document in the transaction.

  • registryId — Name that will be given to the document within the e-Vault Manager. This name must be unique within the given instance of the e-Vault Manager.
  • borrowers — A JSON array that contains one or more OneSpan Sign Role IDs. Before the transaction can be distributed for signing, each Role ID in this array must match the Role ID of a role in the transaction.
  • loanId — Unique ID of the loan, according to the customer's system
  • loanAmount — Original amount of the loan in US cents
  • lender — Name of the lender for this loan

The JSON array may also contain the following optional field:

  • vaultId — This is the vaultId of the entry in the vaults array. If this parameter is not specified, the system will use the vaultId of the vaults parameter. If this parameter is specified, it must match the vaultId of the vaults parameter.

version No

Version of the protocol to be used. Currently the only supported value is eLending-1.0.

postRegisterOption No

After the authoritative copy of a document is registered with the e-Vault Manager, it is removed from OneSpan Sign. This parameter specifies how this authoritative copy will be replaced. The supported values are:

  • watermark_doc (default) — After a document is registered with the e-Vault Manager, the signed PDF content is watermarked, flattened, and saved in OneSpan Sign.

  • blank_doc — After a document is registered with the e-Vault Manager, the signed PDF content is replaced in OneSpan Sign with a blank document.

Example

Here is an example of a Base64-decoded "registry_data" value:

{
    "version": "eLending-1.0",
    "postRegisterOption": "watermark_doc",
    "vaults": [{
            "transaction": "sample-transaction1",
            "orgId": "org1",
            "vaultId": "1"
        }
    ],
    "registryRecords":[{
            "documentId":"UnsignedDocument01",
            "registryId": "loan123-Id01",
            "borrowers": ["Borrower2"],
            "loanId": "loan123",
            "loanAmount": "999999",
            "lender": "ABC Corporation",
            "vaultId": "1"
        },{
            "documentId":"UnsignedDocument02",
            "registryId": "loan123-Id02",
            "borrowers": ["Borrower3"],
            "loanId": "loan234",
            "loanAmount": "999",
            "lender": "Ajax Corporation",
            "vaultId": "1"
        }
    ]
}