Last updated

Request

The request structure follows the MISMO XML Versions 2.X credit reporting standards.

Individual Credit Request

The following is an individual credit request example:

<?xml version="1.0" encoding="UTF-8"?>
<REQUEST_GROUP MISMOVersionID="2.3.1">
	<REQUESTING_PARTY _Name="Customer Name Here"/>
	<SUBMITTING_PARTY _Name="Software/Platform Name Here"/>
	<REQUEST RequestDatetime="2012-01-01T12:00:00">
		<REQUEST_DATA>
			<CREDIT_REQUEST MISMOVersionID="2.3.1" LenderCaseIdentifier="LoanNumber1">
				<CREDIT_REQUEST_DATA CreditRequestID="requestID" BorrowerID="B1" CreditReportRequestActionType="Submit" CreditReportType="Merge" CreditRequestType="Individual">
					<CREDIT_REPOSITORY_INCLUDED _EquifaxIndicator="Y" _ExperianIndicator="Y" _TransUnionIndicator="Y"/>
				</CREDIT_REQUEST_DATA>
				<LOAN_APPLICATION>
					<BORROWER BorrowerID="B1" _FirstName="Nickie" _MiddleName="C" _LastName="Green" _NameSuffix="" _SSN="123003333">
						<_RESIDENCE _StreetAddress="100 Terrace Ave." _City="West Haven" _State="CT" _PostalCode="06516" BorrowerResidencyType="Current"/>
					</BORROWER>
				</LOAN_APPLICATION>
			</CREDIT_REQUEST>
		</REQUEST_DATA>
	</REQUEST>
</REQUEST_GROUP>

Joint Credit Request

The following is a joint credit request example:

<?xml version="1.0" encoding="UTF-8"?>
<REQUEST_GROUP MISMOVersionID="2.3.1">
	<REQUESTING_PARTY _Name="Customer Name Here"/>
	<SUBMITTING_PARTY _Name="Software/Platform Name Here"/>
	<REQUEST RequestDatetime="2012-01-01T12:00:00">
		<REQUEST_DATA>
			<CREDIT_REQUEST MISMOVersionID="2.3.1" LenderCaseIdentifier="LoanNumber1">
				<CREDIT_REQUEST_DATA CreditRequestID="requestID" BorrowerID="B1 C1" CreditReportRequestActionType="Submit" CreditReportType="Merge" CreditRequestType="Joint">
					<CREDIT_REPOSITORY_INCLUDED _EquifaxIndicator="Y" _ExperianIndicator="Y" _TransUnionIndicator="Y"/>
				</CREDIT_REQUEST_DATA>
				<LOAN_APPLICATION>
					<BORROWER BorrowerID="B1" _FirstName="John" _MiddleName="" _LastName="Homeowner" _NameSuffix="" _SSN="999405000">
						<_RESIDENCE _StreetAddress="175 13th St" _City="Washington" _State="DC" _PostalCode="20013" BorrowerResidencyType="Current"/>
					</BORROWER>
                                        <BORROWER BorrowerID="C1" _FirstName="Mary" _MiddleName="" _LastName="Homeowner" _NameSuffix="" _SSN="500222000">
						<_RESIDENCE _StreetAddress="175 13th St" _City="Washington" _State="DC" _PostalCode="20013" BorrowerResidencyType="Current"/>
					</BORROWER>
				</LOAN_APPLICATION>
			</CREDIT_REQUEST>
		</REQUEST_DATA>
	</REQUEST>
</REQUEST_GROUP>

Individual Credit Request with Service Payment Information

For customers using point-of-sale, the SERVICE_PAYMENT element must be included to provide payment details when requesting the report.

The following is an individual credit request, including the SERVICE_PAYMENT element, example:

<?xml version="1.0" encoding="UTF-8"?>
<REQUEST_GROUP MISMOVersionID="2.3.1">
	<REQUESTING_PARTY _Name="Customer Name Here"/>
	<SUBMITTING_PARTY _Name="Software/Platform Name Here"/>
	<REQUEST RequestDatetime="2012-01-01T12:00:00">
		<REQUEST_DATA>
			<CREDIT_REQUEST MISMOVersionID="2.3.1" LenderCaseIdentifier="LoanNumber1">
				<CREDIT_REQUEST_DATA CreditRequestID="requestID" BorrowerID="B1" CreditReportRequestActionType="Submit" CreditReportType="Merge" CreditRequestType="Individual">
					<CREDIT_REPOSITORY_INCLUDED _EquifaxIndicator="Y" _ExperianIndicator="Y" _TransUnionIndicator="Y"/>
				</CREDIT_REQUEST_DATA>
				<SERVICE_PAYMENT _AccountIdentifier="4007000000027" _AccountHolderName="John Q Consumer" _AccountExpirationDate="2025-02" _SecondaryAccountIdentifier="" _MethodType="Visa" />
				<LOAN_APPLICATION>
					<BORROWER BorrowerID="B1" _FirstName="Nickie" _MiddleName="C" _LastName="Green" _NameSuffix="" _SSN="123003333">
						<_RESIDENCE _StreetAddress="100 Terrace Ave." _City="West Haven" _State="CT" _PostalCode="06516" BorrowerResidencyType="Current"/>
					</BORROWER>
				</LOAN_APPLICATION>
			</CREDIT_REQUEST>
		</REQUEST_DATA>
	</REQUEST>
</REQUEST_GROUP>


Refer to the individual POST operations and/or the test Postman collection for a complete set of examples.

Report Types and Actions

The attribute values within the CREDIT_REQUEST_DATA element determine the type of report and the action to be invoked as summarized in Table 1.

Table 1

SubmitForceNewReissueUpgradeUnmerge
Credit ReportXCreditReportRequestActionType="Submit"
CreditReportType="Merge"
CreditReportRequestActionType="ForceNew"
CreditReportType="Merge"
CreditReportRequestActionType="Reissue"
CreditReportType="Merge"
CreditReportIdentifier="XXXXXXX"
CreditReportRequestActionType="Upgrade"
CreditReportType="Merge"
CreditReportIdentifier="XXXXXXX"
CreditReportRequestActionType="Unmerge"
CreditReportType="Merge"
CreditReportIdentifier="XXXXXXX"
Pre-QualificationXCreditReportRequestActionType="Submit"
CreditReportType="Other"
CreditReportTypeOtherDescription="SoftCheck"
CreditReportRequestActionType="ForceNew"
CreditReportType="Other"
CreditReportTypeOtherDescription="SoftCheck"
CreditReportRequestActionType="Reissue"
CreditReportType="Other"
CreditReportTypeOtherDescription="SoftCheck"
CreditReportIdentifier="XXXXXXX"
CreditReportRequestActionType="Upgrade"
CreditReportType="Other"
CreditReportTypeOtherDescription="SoftCheck"
CreditReportIdentifier="XXXXXXX"
Mortgage OnlyCreditReportRequestActionType="Submit"
CreditReportType="Other"
CreditReportTypeOtherDescription="Streamline"
CreditReportRequestActionType="ForceNew"
CreditReportType="Other"
CreditReportTypeOtherDescription="Streamline"
CreditReportRequestActionType="Reissue"
CreditReportType="Other"
CreditReportTypeOtherDescription="Streamline"
CreditReportIdentifier="XXXXXXX"
CreditReportRequestActionType="Upgrade"
CreditReportType="Other"
CreditReportTypeOtherDescription="Streamline"
CreditReportIdentifier="XXXXXXX"
Refresh ReportCreditReportRequestActionType="Submit"
CreditReportType="Other"
CreditReportTypeOtherDescription="Refresh"
CreditReportIdentifier="XXXXXXX"
CreditReportRequestActionType="Reissue"
CreditReportType="Other"
CreditReportTypeOtherDescription="Refresh"
CreditReportIdentifier="XXXXXXX"

Explore the downloadable table above - Report Types and Actions.

CreditReportType Attribute

The CreditReportType attribute must be set to one of the following accepted values:

  • Merge: Credit ReportX (CRx) is a standard tri-merge credit report that contains information from one or more of the major credit bureaus (Equifax, Experian, TransUnion). A CRx report is also referred to as a "hard inquiry" or "hard pull", meaning the request for the credit information will hit/show up on/impact an applicant's credit report.
  • Other: Non-standard report type.

CreditReportTypeOtherDescription Attribute

When the CreditReportType attribute is set to “Other”, the CreditReportTypeOtherDescription attribute must be added and set to one of the following accepted values:

  • Streamline: Mortgage Only is a credit report that contains information regarding the borrower’s credit score and the borrower's mortgage history only. A Mortgage Only report is also considered to be a "hard inquiry" or "hard pull", meaning the request for the credit information will hit/show up on/impact an applicant's credit report.
  • SoftCheck: Pre-QualificationX (PQx) is a soft-inquiry credit report that generates a consumer consent-based report that contains information from one or more of the major credit bureaus. A PQx report provides means to quickly learn if consumers meet credit criteria. Information returned in the PQx report provides insight into what loan products the consumers may qualify for without requiring them to go through a formal credit application process.
  • Refresh: Refresh Report is a soft-inquiry credit report of the original “merged” Credit ReportX it is referencing. The Refresh Report will provide a comparison of the original merged report to see if anything has changed since the original credit report was pulled (often used right before closing as a final check).

CreditReportRequestActionType Attribute

The CreditReportRequestActionType attribute must be set to one of the following accepted values to invoke the requested action:

  • Submit: This action type permits a request for a credit report. Alternatively, a submit request will execute a reissue if the borrower’s name, address, and SSN match an existing report (for both borrowers, if applicable), and if the existing report was pulled within 30 days. The CreditReportIdentifier attribute is generated in the response upon new request. For the Refresh Report, the request must reference the existing credit report in the CreditReportIdentifier attribute.
  • ForceNew: This action type permits a new request and forces new data to be obtained from the repositories. The CreditReportIdentifier attribute is generated in the response upon new request.
  • Reissue: This action type permits a reissue of an existing credit report. This action will always return the original credit report, even if that report has subsequently been upgraded. By default, reissues are only permitted within 30 days of the original merged report order. The request must reference the existing credit report in the CreditReportIdentifier attribute.
  • Upgrade: This action type permits an addition of a repository or a removal of a borrower from an existing credit report. To add repositories, indicate the included repositories within the CREDIT_REPOSITORY_INCLUDED element as "Y" (previously ordered repositories cannot be removed using this option.) To remove a borrower, include only the desired borrower’s information in the request, which must match one of the borrowers present on the original report. When removing a borrower, a new report is created and a new CreditReportIdentifier is returned in the response. The request must reference the existing credit report in the CreditReportIdentifier attribute.
  • Unmerge: This action type permits an unmerge or separation of credit repositories from an existing merged credit report into a new report. This action can only be used with Credit ReportX. To unmerge repositories, indicate the excluded repositories within the CREDIT_REPOSITORY_INCLUDED element as “N”. The request must reference the existing credit report in the CreditReportIdentifier attribute.

Request Attributes

Refer to Table 2 for a set of required and commonly used request attributes.


Table 2

ElementAttributeOptionalFormatExample
REQUEST_GROUPMISMOVersionIDstring (Refer to the Digest for allowed values.)2.3.1
REQUESTING_PARTY_NamestringABC Mortgage Company
SUBMITTING_PARTY_NamestringABC Platform
RECEIVING_PARTY_NameOptionalstringXactus, LLC
REQUESTRequestDatetimedate/time (YYYY-MM-DDTHH:mm:ss)2022-02-24T04:00:00
InternalAccountIdentifierOptionalstring10105678
RequestingPartyBranchIdentifierOptionalstring123
REQUEST / KEY_NameOptionalstringApplicationRecordUID
_ValueOptionalstring1234567-ab-012345
CREDIT_REQUESTMISMOVersionIDstring (Refer to the Digest for allowed values.)2.3.1
LenderCaseIdentifierstring (Max length 40)LoanNumber1
RequestingPartyRequestedByNameOptionalstringSusan B
CREDIT_REQUEST_DATACreditRequestIDstring7c68e9c7
BorrowerIDstringB1
CreditReportRequestActionTypestringSubmit
CreditReportTypestringOther
CreditReportTypeOtherDescriptionstringSoftCheck
CreditRequestTypestring (Joint or Individual)Individual
CreditReportIdentifierstring1102123
CREDIT_REPOSITORY _INCLUDED_EquifaxIndicatorboolean (Y or N)Y
_ExperianIndicatorboolean (Y or N)Y
_TransUnionIndicatorboolean (Y or N)Y
SERVICE_PAYMENT (point-of-sale customers only)_AccountIdentifierstring4007000000027
_AccountHolderNamestringJohn Q Consumer
_AccountExpirationDatedate/time (YYYY-MM)2025-02
_SecondaryAccountIdentifierstring (CVV)409
_MethodTypestring (Visa, Mastercard, AmericanExpress, or Discover)Visa
LOAN_APPLICATION / BORROWERBorrowerIDstringB1
_FirstNamestringNickie
_MiddleNamestringC
_LastNamestringGreen
_NameSuffixstring
_SSNstring (XXXXXXXXX or XXX-XX-XXXX, ITIN also supported)123003333
_BirthDateOptionaldate/time (YYYY-MM-DD)2001-01-02
_PrintPositionTypeOptionalstringBorrower
_AgeAtApplicationYearsOptionalstring23
DependentCountOptionalstring2
MaritalStatusTypeOptionalstringUnmarried
_HomeTelephoneNumberOptionalstring555-555-1234
LOAN_APPLICATION / BORROWER / _RESIDENCE_StreetAddressstring100 Terrace Ave.
_CitystringWest Haven
_State (military state codes supported)stringCT
_PostalCodestring (Max length 5)06516
BorrowerResidencyTypestring (Current or Prior)Current
BorrowerResidencyDurationYearsOptionalstring6
LOAN_APPLICATION / BORROWER / _MAIL_TO_StreetAddressOptionalstring400 S Main St
_CityOptionalstringWest Haven
_StateOptionalstringCT
_PostalCodeOptionalstring06516
LOAN_APPLICATION / BORROWER / EMPLOYER_NameOptionalstringEmployer, Inc.
_StreetAddressOptionalstring92 Howe St
_CityOptionalstringWest Haven
_StateOptionalstringCT
_PostalCodeOptionalstring06516
_TelephoneNumberOptionalstring555-999-5678
PreviousEmploymentEndDateOptionaldate/time (YYYY-MM-DD)2019-04-01
PreviousEmploymentStartDateOptionaldate/time (YYYY-MM-DD)2021-06-11
EmploymentCurrentIndicatorOptionalboolean (Y or N)Y
EmploymentPositionDescriptionOptionalstringManager
IncomeEmploymentMonthlyAmountOptionalstring3000.00
LOAN_APPLICATION / LIABILITYBorrowerIDOptionalstringB1
_HolderNameOptionalstringABC Lending Company
_AccountIdentifierOptionalstring143435
_ExclusionIndicatorOptionalboolean (Y or N)N
_MonthlyPaymentAmountOptionalstring150.00
_TypeOptionalstringInstallment
_UnpaidBalanceAmountOptionalstring3000.00
LOAN_APPLICATION / PROPERTY_StreetAddressOptionalstring99 North Pole St
_CityOptionalstringMilford
_StateOptionalstringCT
_PostalCodeOptionalstring (Max length 5)06460
LOAN_APPLICATION / MORTGAGE_TERMSMortgageTypeOptionalstringFHA