This page contains the following information for Credit Partners:
- Product Attributes - Describes all possible attributes for credit partners.
- Credit Partner Information and Samples - Describes the Options object for supported credit partners based on credit partner group number.
Product Attributes
The following table lists all possible attributes for credit partners. Not all attributes are required for a given partner. Use the Option object samples provided in the Credit Partner Information and Samples section above as a reference to see which attributes are required for a given vendor.
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}#{borrowerId} |
entityRef.entityType string | The type of entity expressed in URN format. For example: urn:elli:encompass:{loan}:{borrower} |
name string | Name of the service to order. See the Partner Information section to get the correct name value for the partner; either the Transaction_Resource object or Transaction object name. |
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 cannot be passed simultaneously in a request - they are mutually exclusive. |
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. |
credentials.userName string | Username for the service provider account. |
credentials.password string | Password for the service provider account. |
credentials.providerID string | Provider ID for the service provider accounts. Note: This attribute is applicable to Partners in group #2 only. |
credentials.providerID string | Subscriber ID for the service provider account. Note: This attribute is applicable to Partners in group #2 only. |
options object | Important! The parameters defined by the options object will be different depending on the service provider you choose. For credit services, refer to the samples in the Credit Partner Information and Samples. |
options.digiCert boolean | Determines how to authenticate to TransUnion. true - Indicates a DigiCert SSL certificate will be used. false - Indicates the user name and password will be used to authenticate. |
options.requestType string | Indicates the request type being submitted. Possible values are NewOrder and Reissue. |
options.reportOn string | Possible values are: Individual - Requests a report on one borrower. Joint - Requests reports on both borrowers. |
options.reportType string | Type of credit report. Possible values are: RMCR - Residential Mortgage Credit Report. Merge - Instant Merge credit report. Infile - Credit report. |
options.creditReportIdentifier string | Identifier assigned by the credit partner. It is returned in the response and is required to reissue or update a report. |
options.note string | Comment or note to add to the request. |
options.excludeZeroforImportLiabilities boolean | Whether to exclude zero liability balances from future credit report import files. |
options.creditBureauExperian boolean | A value of true indicates the request is submitted to Experian. |
options.creditBureauEquifax boolean | A value of true indicates the request is submitted to Equifax. |
options.creditBureauTransUnion boolean | A value of true indicates the request is submitted to TransUnion. |
options.ficoScore boolean | Indicates whether to retrieve the credit score from the partner. |
options.fraudSearch boolean | Indicates whether to initiate a fraud search while retrieving the credit score. |
preferences | |
preferences.importLiabilities boolean | When set to true, imports all liabilities. When set to false, no liabilities are imported. |
preferences.excludeZeroforImportLiabilities 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.
|
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 and Encompass eFolder document: urn:elli:encompass:document |
Credit Partner Information and Samples
Use the Product Name listed under the Transaction_Resource or Transaction columns to create transactions that follow the respective schema.
Group 1
Partner | Partner ID | Product Name - Transaction_Resource |
---|---|---|
Avantus | 306113 | Credit-CBCTAvantus |
CBCInnovis, Inc | 304369 | Credit-CBCInnovis |
CoreLogic | 274365 | Credit-CoreLogic |
Equifax Mortgage Services | 307827 | Credit-Equifax |
Factual Data by CBC | 304369 | Credit-FactualDataCBC |
Informative Research | 306025 | Credit-InformativeResearch |
Group 1 Sample
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"clientID": "<Accout ClientID (optional if applicable)>"
},
"options": {
"requestType": "<NewOrder|Reissue>",
"reportOn": "<Individual|Joint>",
"reportType": "Infile",
"creditReportIdentifier": "",
"creditBureauExperian": true,
"creditBureauEquifax": true,
"creditBureauTransUnion": true
}
}
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"clientID": "<Accout ClientID (optional if applicable)>"
},
"options": {
"requestType": "<NewOrder|Reissue>",
"reportOn": "<Individual|Joint>",
"reportType": "Merge",
"creditReportIdentifier": "",
"creditBureauExperian": true,
"creditBureauEquifax": true,
"creditBureauTransUnion": true
}
}
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"clientID": "<Accout ClientID (optional if applicable)>"
},
"options": {
"requestType": "<NewOrder|Reissue>",
"reportOn": "<Individual|Joint>",
"reportType": "Merge",
"creditReportIdentifier": "",
"creditBureauExperian": true,
"creditBureauEquifax": true,
"creditBureauTransUnion": true
}
}
Group 2
Partner | Partner ID | Product Name - Transaction_Resource |
---|---|---|
ACB Credit Solutions | 307374 | Credit-ACBCreditSolutions |
Accurate Financial Services | 223756 | Credit-AccurateFinancialServices |
ACRAnet Inc. | 305770 | Credit-ACRAnet |
Credit Information Service, Inc. | 313049 | Credit-CreditInformationServices |
Credit Information Systems | 11124868 | Credit-CreditInformationSystems |
Data Facts, Inc. | 307446 | Credit-DataFacts |
DCI Credit Services, Inc | 311105 | Credit-DCICreditServices |
MFI Credit Solutions | 174688 | Credit-MFICreditSolutions |
Mortgage Reporting Center | 306108 | Credit-MortgageReportingCenter |
NCO Credit Services (Power by Synergistic) | 304647 | Credit-NCOCS |
Network Credit Services | 305310 | Credit-NetworkCreditServices |
NMR-SettlementOne | 305308 | CreditNMR-SettlementOne |
One Source Credit Reporting, LLC | 305312 | Credit-OneSourceCreditReporting |
Online Mortgage Reports | 306957 | Credit-OnlineMortgageReports |
San Antonio Retail Merchants Association (SARMA) | 307479 | Credit-SARMASL |
Sharper Lending | 11132718 | Credit-SharperLending |
Strategic Information Resources, Inc | 305917 | Credit-StrategicInformationResources |
Group 2 Sample
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"providerId": "<Accout ProviderID>",
"subscriberId": "<Accout SubscriberID"
},
"options": {
"requestType": "<NewOrder|Reissue>",
"reportOn": "<Individual|Joint>",
"productCode": "<ProductCode>"
--Unique product code assigned by SL and could be different based on user profile. The code returned -- in a separate call to SL "creditReportIdentifier": "",
}
}
Group 3
Partner | Partner ID | Product Name - Transaction_Resource |
---|---|---|
Covius Mortgage Solutions | 11025251 | Credit-Covius |
Partner Credit & Verification Solutions (Old Republic) | 311509 | Credit-OldRepublic |
Transunion | 11213781 | Credit-TransUnion |
Group 3 Sample
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"clientID": "<Accout ClientID (optional if applicable)>"
},
"options": {
"requestType": "<NewOrder|Reissue>",
"reportOn": "<Individual|Joint>",
"reportType": "Merge",
"creditReportIdentifier": "",
"creditBureauExperian": true,
"creditBureauEquifax": true,
"creditBureauTransUnion": true
}
}
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"clientID": "<Accout ClientID (optional if applicable)>"
},
"options": {
"requestType": "NewRequest",
"digiCert": true,
"reportOn": "<Individual|Joint>",
"creditBureauTransUnion": true
}
}
Group 4
Partner | Partner ID | Product Name - Transaction_Resource |
---|---|---|
Advantage Credit Bureau (aka DCI Credit - Services, Inc.) | 311105 | Credit-DCICreditServices |
Advantage Credit, Inc. | 307374 | Credit-AdvantageCredit |
Advantage Plus Credit Reporting, Inc. | 312724 | Credit-AdvantagePlusCreditReporting |
Alliance 2020, Inc. | 308113 | Credit-Alliance2020 |
American Reporting Company, LLC (Powered by MeridianLink) | 306453 | Credit-AmericanReportingCompany |
Birchwood Credit Services, Inc. | 305813 | Credit-BirchwoodCreditServices |
Cal Coast Credit Reports | 312720 | Credit-CalCoastCreditReports |
Certified Credit Link, Inc. | 308119 | Credit-CertifiedCreditLink |
Certified Credit Reporting (Powered by MeridianLink) | 306885 | Credit-CertifiedCreditReporting |
CIC Mortgage Credit, Inc. | 308373 | Credit-CICMortgageCredit |
CIS Information Services | 222827 | Credit-CISInformationServices |
CISCO Credit (Powered by MeridianLink) | 304324 | Credit-CISCOCredit |
Clear Choice Credit | 11120203 | Credit-ClearChoiceCredit |
Credit Link, LLC | 311110 | Credit-CreditLink |
Credit Plus (Powered by MeridianLink) | 303815 | Credit-CreditPlus |
Credit Technologies, Inc. | 304604 | Credit-CreditTechnologies |
CTI, Credit Technology, Inc. | 307830 | Credit-CTI |
Data Facts, Inc. | 307446 | Credit-DataFactsInc |
Premium Credit Bureau | 311416 | Credit-PremiumCreditBureau |
Merchants Credit Bureau - Augusta | 10000058 | *Credit-MCBAugusta |
San Antonio Retail Merchants Association (SARMA) (Powered by MeridianLink) | 307479 | Credit-SARMA |
Service 1st Info Systems | 11017572 | Credit-Service1stInfoSystems |
Settlement One Data, LLC | 305308 | Credit-SettlementOneDataLLC |
United One | 306102 | Credit-UnitedOne |
Universal Credit - National | 11100685 | Credit-UniversalCredit |
Group 4 Sample
{
"credentials": {
"userName": "<Accout Username>",
"password": "<Accout Password>",
"clientID": "<Accout ClientID (optional if applicable)>"
},
"options": {
"requestType": "<NewOrder|Reissue>",
"reportOn": "<Individual|Joint>",
"reportType": "Merge",
"creditReportIdentifier": "",
"creditBureauExperian": true,
"creditBureauEquifax": true,
"creditBureauTransUnion": true,
"ficoScore": true,
"fraudSearch": true
}
}