Freddie Mac AIM Check integration

The Freddie Mac AIM Check integration lets you obtain automated income representation-and-warranty (R&W) relief on wage-earner borrowers directly from the documents Ocrolus has already processed. Ocrolus takes the pay stubs and W-2s you've uploaded, transforms the extracted income into Freddie Mac's MISMO-format AIM Check for Payroll Income request, submits it to Freddie Mac, and returns the assessment, eligibility, and certificate. This helps you reduce manual entry effort and helps you lower repurchase risk.

📘

Note

Before using this integration, complete the one-time setup described in the Freddie Mac AIM Check setup guide. The Freddie Mac AIM Check service is available to users accessing the Ocrolus Dashboard from within the United States.

Key capabilities

No re-keying

Reuses income data already extracted from your uploaded pay stubs and W-2s.

Runs automatically

On the wage-earner tab, selecting Freddie Mac as the loan program runs the
calculation — there is no separate button to press.

Automated R&W relief

Returns Freddie Mac's income assessment and per-income-type eligibility
determination.

Always switchable

A radio button lets you switch to Ocrolus's own income calculation at any
time, and a refresh button re-runs the Freddie Mac calculation.

Certificate in-app

Downloads the Freddie Mac certificate PDF directly from the Dashboard.

Encompass write-back

Imports the certificate and Freddie-derived income into your Encompass loan.

Integration flow

  1. Documents reach Ocrolus: Pay stubs and W-2s arrive via your Encompass integration or direct upload in the Dashboard. Ocrolus classifies and extracts the income as usual.
  2. AIM Check runs automatically: When Freddie Mac is selected as the loan program on the wage earner tab, Ocrolus runs the AIM Check. Freddie Mac is the default loan program.
  3. Encompass sets the default: When your Book is connected to Encompass, Ocrolus reads certain loan fields to determine whether the loan defaults to Freddie Mac.
  4. Ocrolus submits to Freddie Mac: Ocrolus transforms the extracted data into a MISMO AIM Check request and submits it securely.
  5. Results appear inline: Freddie Mac returns the assessment result, per-income-type eligibility, and a certificate, displayed inline on the wage-earner tab.

Prerequisites

Before you can run an AIM Check, complete the one-time setup described in the Freddie Mac AIM Check setup guide:

  • You must be a Freddie Mac–approved Seller/Servicer with a valid Seller/Servicer number.
  • Register Ocrolus as your service provider using the Freddie Mac Tools Request Form. Select AIM API Relationship and designate Ocrolus.
  • Provide your Seller number to Ocrolus. Ocrolus configures it on your organization and enables Freddie Mac as a loan program on the wage-earner tab.

Running the AIM Check

Use the following steps to run the Freddie Mac income calculation, review the results, and import the certificate into Encompass:

Step 1: Get documents into the Book

Upload the borrower's pay stubs and W-2s to the Book, either through your Encompass integration or directly in the Dashboard. Ocrolus classifies and extracts them as usual, the same way as the Fannie Mae income calculator. At minimum, provide one pay stub and one current-year W-2.

Step 2: Select Freddie Mac on the wage-earner tab

Open the borrower's Wage-earner tab in Analyze for Mortgage. Freddie Mac is the default loan program, when it is selected in the loan program drop-down, Ocrolus runs the AIM Check automatically. There is no separate button to press. If your Book is connected to Encompass, the default is derived from your Encompass loan data.

Wage-earner tab with the loan-program drop-down set to Freddie Mac and the calculation running/complete.

Step 3: Switch to a manual calculation (optional)

If you'd rather use Ocrolus's own income calculation, select the Ocrolus option using the radio button on the right-hand side of the wage-earner tab. You can switch back to Freddie Mac at any time.

Step 4: Re-run the calculation (optional)

If you update the documents or want to submit again, select the refresh re-run button to run the Freddie Mac income calculation again.

Step 5: Review your results

When the calculation succeeds, the wage-earner tab shows the result. Read the following two outcomes together:

  • Assessment (AIM900): Confirms Freddie Mac processed your request successfully. The status should reflect to AIM900. This does not by itself mean the income is eligible.
  • Eligibility (AIM1000): Indicates whether each income type qualifies for representation-and-warranty (R&W) relief.
💡

Tip

A successful assessment (AIM900) does not guarantee eligibility. Always check the eligibility result for each income type before relying on R&W relief.

If Freddie Mac cannot assess the income or the request has a data problem, an error message is returned on the tab. To learn more about the common error messages, error code, and how to resolve them, see the Troubleshooting and Known error sections.

Successful message

Error Message
Results view: success message, per-income-type eligibility, Freddie-derived income, and the certificate download.

Step 6: Download the certificate or import to Encompass

Download the Freddie Mac certificate PDF from the wage-earner tab. If your loan is connected via Encompass Partner Connect, select Import to Encompass to write the certificate titled Freddie Mac AIM Check Assessment, and the Freddie-derived income back to the loan.

Supported income types

AIM Check supports the following income types for wage-earner (pre-close) borrowers documented with pay stubs and W-2s.

Income typeNotes
BasePrimary wage-earner income from pay stubs and W-2s.
BonusVariable income; requires supporting documentation to derive a value.
CommissionVariable income; requires supporting documentation to derive a value.
OvertimeVariable income; requires supporting documentation to derive a value.
📘

Note

Variable income (Bonus, Commission, and Overtime) is derived from the documentation provided. A single current pay stub may not establish a value for these types.


Known errors

If the Freddie Mac calculation cannot complete, one of the following messages is returned on the wage earner tab. Most are resolved by confirming the documents are uploaded and linked to the borrower, then re-running.

CodeWhat it meansWhat to do
AIM901The submitted income could not be assessed.Confirm the required pay stub(s) and W-2 are uploaded and linked to the borrower, then re-run.
AIM904Advisory — the calculation may be affected by missing or incorrect data.Review the flagged data. For example, application received date. The result may still be usable.
AIM905A borrower name is required.Ensure the borrower's first and last name are present, then re-run.
AIM906No viable income records were found.Confirm usable pay stub/W-2 income is uploaded, then re-run.
AIM907Freddie Mac internal error (temporary).Wait a moment and re-run.
AIM908Advisory — some documents may not be linked to a borrower.Check SSNs and borrower names, the income is still assessable.
AIM909No documents were linked to a borrower.Link the documents to the borrower (check SSNs and names), then re-run.
AIM021Freddie Mac is temporarily unable to assess the data.Re-run. If it persists, contact support (800-FREDDIE).
AIM038The documents exceeded the size or file-count limit.Reduce the number or size of documents and re-run.
AIM040A borrower SSN was not provided.Ensure the borrower SSN is present, then re-run.
AIM044Required income data was missing from the request.Confirm the required pay stub/W-2 data is present, then re-run.

Importing to Encompass

If your Book is connected to Encompass through Partner Connect, select Import to Encompass on the wage-earner tab to write the results back to the loan. Ocrolus imports:

  • The Freddie Mac certificate PDF titled Freddie Mac AIM Check Assessment into the eFolder.
  • Income eligibility and Freddie-derived income amounts.
  • The Freddie Mac reporting information identifier for the assessment.
📘

Note

Import to Encompass requires the loan to be connected via Encompass Partner Connect and unlocked. If the loan is locked, unlock it in Encompass and try again.

Requirements and limitations

RequirementsLimitations
Minimum documentsAt least one pay stub and one current-year W-2 are needed to produce an assessment.
ScopeWage-earner (pre-close) payroll income. Self-employed and asset scenarios are not part of this integration.
AccessThe service is available from within the United States.
No manual entryAIM Check uses the extracted document data. If required data is missing, re-upload or reprocess the documents rather than entering values manually.

Related resources


Did this page help you?