Electronic Verifications Partners and Samples

Use the Services API to submit requests and retrieve reports from third-party verification services. The Services API currently supports the following electronic verifications:

Verification of Employment (VOE)

📘
NOTE
4506-T verification support will be available in a future release.

This page contains the common product attributes used by all verification service partners, as well as attributes and samples that are specific to each verification service partner.

To view attributes and samples for Verification of Employment, see Verification of Employment (VOE).

Product Attributes

The following table lists common attributes for verification vendors. Not all attributes are required for a given partner. Use the Option object samples provided in the sections below as a reference to see which attributes are required for a given vendor and service.

ATTRIBUTE	DESCRIPTION
entityRef object	References the entity ID and entity type. Both must include the loan ID and borrower application ID associated with the loan. Both are returned by getLoan.
entityRef.entityId string	The entity identifier. For example: {loanId}#{borrowerApplicationId}
entityRef.entityType string	The type of entity expressed in URN format. For example: urn:elli:encompass:{loanId}:{borrowerId}
name string	The Product Name. See the VOE Partner Information table below to get the correct name value for the partner. Use the Product Name for either the Transaction_Resource object or Transaction object name.

options object	Important! The parameters defined by the options object will be different depending on the service provider you choose. For VOE services, refer to the information and samples in the Electronic Verification of Employment.

credentialStore string	Optional Indicates that the API user will use credentials stored in the Encompass Services Password Manager at a user-level. Currently, user is the only supported value. Note: The credentials object and the credentialStore attribute can not be passed simultaneously in a request - they are mutually exclusive.

preferences
preferences.importLiabilities boolean	When set to true, imports all liabilities. When set to false, no liabilities are imported.
preferences.excludeZeroBalances boolean	Whether to exclude zero liability balances from silent liability import files.
preferences.autoSave boolean	When set to true, the service provider’s response is automatically saved to Encompass. When set to false, the lender is prompted to save the service provider’s response to Encompass.

credentials object	Login credentials for the service provider. Note: You must have an account with the service provider. You'll use the same account credentials required by the service provider to order services.
branchId string	The associated branch ID of the lender. For example: ca-12345
credentials.username string	Username for the service provider account.
credentials.password string	Password for the service provider account.

resources object	Optional. This object contains the resources (documents and attachments) associated with the loan that are being shared with the service partner with respect to the service request. You may send documents and attachments if necessary.
resources.entityId string	Optional. The entity identifier for the resource. If the resource you are passing is an eFolder attachment, the attachmentId is required. If the resource you are passing is an eFolder document, the documentId is required. You can retrieve these from using the eFolder Attachment and eFolder Document APIs.
resources.entityType string	Optional. The entity type/format of the resource. Possible values include: For an Encompass eFolder attachment: urn:elli:encompass:attachment For an Encompass eFolder document: urn:elli:encompass:document

VOE Partner Information

Use the Product Name listed under the Transaction_Resource or Transaction columns to create transactions that follow the respective schema.

Partner Name	Partner ID	Product Name (Transaction_Resource)	Product Name (Transaction)
The Work Number for VOE	11125641	Verification-TheWorkNumber	Verif

Electronic Verification of Employment

VOE Options Attributes

Options payload used for ordering employment verification services. All attributes are required unless specified otherwise.

ATTRIBUTE	DESCRIPTION
requestType string	Indicates the type of request you are submitting. Possible values are: OrderVerification - a request for a regular VOE OrderResearchedVerification - this requestType is placed when a regular orderVerification requestType could not verify the borrowers employment. The response is not immediate and is likely to take few (< 3) days.
reportOn string	Indicates whose employment to verify. When set to Borrower, a report is requested for the borrower. When set to Co-Borrower, reports are requested for both the borrower and co-borrower.
employment string	Type of employment. Possible values are: EmploymentOnly EmploymentPlusIncome
employer string	Employer status. Possible values are either: Current Employer(s) Previous Employer(s) * Both (Current & Previous)
digiCert boolean	Determines how to authenticate to The Work Number. When set to true, a DigiCert SSL certificate will be used for authentication When set to false, the user name and password will be used for authentication.
verificationReportIdentifier string	Conditionally Required. Internal identifier used by The Work Number to track a previously ordered verification report
salaryKey string	Optional Six-digit number that allows one-time access to salary information.
employerName string	Name of the borrower's employer.
employerCode string	Internal code used by The Work Number to refer to an employer in their employer database.
alternateID string	Alternate ID used if the employee is a government employee. Note: If this field is specified, employerName, salaryKey, and employerCode must also be specified.

VOE Partner Sample

{
  "options": {
    "requestType": "OrderVerification",
    "verificationReportIdentifier": "",
    "employment": "EmploymentOnly",
    "employer": "Current Employer(s)",
    "employeeID": "",
    "employerName": "",
    "employerCode": "",
    "alternateID": "",
    "reportOn": "Borrower",
    "digiCert":true
  }
}

📘NOTE

Product Attributes

VOE Partner Information

Electronic Verification of Employment

VOE Options Attributes

VOE Partner Sample

📘
NOTE