Skip to main content
Skip table of contents

🧩UWM Integration

Effortlessly connect with our trusted partners at UWM (United Wholesale Mortgage) to enhance the efficiency of your operations. We'll provide step-by-step guidance, ensuring that your integration is both swift and trouble-free.

Before proceeding with this step, please ensure you have the following details ready:

  • Credentials for each of your branches from UWM (You can seek assistance from your Account Executive to obtain this information).

    • ClientID

    • ClientSecret

📦Create the Loan Condition Permission Set

Click the button to create a permission set. This can be assigned to Users and will give them access to see Loan Conditions in Salesforce.

✏️Create Auth Providers

Auth Providers

  1. Click the “Create Providers” button in the Onboarding Wizard:

  2. Click “New” to create a new Auth. Provider:

Carefully enter the “Name” and “URL Suffix” and ensure they match the details below

  1. From the “Provider Type” picklist select “UWM_Insights_AuthProvider” and enter the following details:

    1. Name: “UWM_InsightsOAuth”

    2. URL Suffix: “UWM_InsightsOAuth”

    3. AuthProviderName: Enter your UWM Client ID credential

    4. ClientSecret: Enter your UWM Client Secret credential

    5. Execute Registration As: Select your Salesforce Admin user

  1. Click “Save & New” and enter the following details:

    1. Provider Type: UWMConditions_AuthProvider

    2. Name: “UWM_ConditionsAuth”

    3. URL Suffix: “UWM_ConditionsAuth”

    4. AuthProviderName: Enter your UWM Client ID credential

    5. ClientSecret: Enter your UWM Client Secret credential

    6. Execute Registration As: Select your Salesforce Admin user

  1. Once you have created both Auth Providers, navigate back to the Onboarding Wizard.

🔑 Create Named Credentials

  1. Click the “Create Credentials” button

  1. From this screen, click the dropdown arrow next to the “New” button and select “New Legacy”

  1. Create the UWMConditions Named Credential:

    1. Label: UWMConditions

    2. Name: UWMConditions

    3. URL: https://api.uwm.com/loan/v1

    4. Identity Type: Named Principal

    5. Authentication Protocol: OAuth 2.0

    6. Authentication Provider: UWM_ConditionsAuth (click the magnifying glass next to this field to select this option)

    7. Scope: all

    8. Start Authentication Flow on Save: Checked

    9. Generate Authentication Header: Checked
      *Once you click Save, the page will refresh and the Authentication Status will change from “Pending” to “Authenticated.

  1. Navigate to the Onboarding Wizard and click “Create Providers” once more.

  2. Create the UWMInsights Named Credential. Be sure to click the dropdown arrow next to the “New” button and select “New Legacy

    1. Label: UWMInsights

    2. Name: UWMInsights

    3. URL: https://api.uwm.com/brokers/insights

    4. Identity Type: Named Principal

    5. Authentication Protocol: OAuth 2.0

    6. Authentication Provider: UWM_InsightsOAuth (click the magnifying glass next to this field to select this option)

    7. Scope: all

    8. Start Authentication Flow on Save: Checked

    9. Generate Authentication Header: Checked

🌐Translate Loan Stages

Now, we will synchronize UWM's loan stages with the corresponding stages used by your company. UWM uses distinct terminology for various stages in the loan process, so we'll need to align UWM's loan stages with your corresponding stages. Make sure you have your loan stage information readily available.

  1. Click on “Map Statuses to UWM.”

    the following page will open in a new tab:

  2. Click on “Manage UWM Translated Values”, you will be navigated to this page:

  3. Click on “New”, you will be navigated to this page:

    1. For each of your company’s loan stages, do the following - For this example we’ll be using the “Application Approved” stage.

      1. Label

        1. Enter your company's loan stage name: "Application Approved."

      2. UWM Translated Value Name

        1. This field is auto-generated based on the label field: "Application_Approved."

      3. Input Value

        1. Use the API field sent by UWM: "App_Pass_Approved."

      4. Output Value

        1. Indicate what your company calls the loan stage: "Application Approved."

      5. Input Value Deprecated

        1. Keep this field blank.

      6. Protected Component

        1. Leave this unchecked.

      7. UWM Insights Mapping

        1. Click the search tool, and in the new window, select "StageName."

  4. Select “Save & New”, repeat step 3.

  5. When you have mapped all loan stages, navigate back to the Onboarding Wizard and click the blue ☑️ next to “Map Statuses to UWM.”

UWM's Loan Statuses

Application Approved - Not Accepted
Closing Package Received
Collateral Deficiency
Dead Import Holding
Funded
Incomplete - Loss of Borr. Contact
Loan Disbursed
Post Closed
Post Close Problem
Rejected
Rescinded
Shipped
Wholesale - Approved With Conditions
Wholesale - Clear To Close
Wholesale - Closing
Wholesale - File Imported
Wholesale - Setup
Wholesale - Suspended
Wholesale - Underwriting
Withdrawn

Create Condition Group Keys:

  1. Click the “Create Metadata Records” to get started on creating the Condition Groups that will sync from UWM.

  1. From this screen, click the new button:

  1. Create the Underwriter II (PTD) Condition Group

    1. Label: Underwriter II (PTD)

    2. UWMLoanConditionsGroups Name: Underwriter_II_PTD

    3. Condition Group Key: Underwriter II (PTD)

  1. Create the Closing (PTF) Condition Group

    1. Label: Closing (PTF)

    2. UWMLoanConditionsGroups Name: Closing_PTF

    3. Condition Group Key: Closing (PTF)

  1. Create the Project Review (PTD) Condition Group

    1. Label: Project Review (PTD)

    2. UWMLoanConditionsGroups Name: Project_Review_PTD

    3. Condition Group Key: Project Review (PTD)

  1. Create the Senior Underwriter (PTD) Condition Group

    1. Label: Senior Underwriter (PTD)

    2. UWMLoanConditionsGroups Name: Senior_Underwriter_PTD

    3. Condition Group Key: Senior Underwriter (PTD)

  1. Create the Master Condition Group

    1. Label: Master

    2. UWMLoanConditionsGroups Name: Master

    3. Condition Group Key: Master

🏷️Customize Borrower Labels

During this step, you'll have the opportunity to review the conditions integrated into our application. Additionally, we will guide you through the process of editing any condition labels as needed.

  1. Click the “Take Me to Preloaded Loan Conditions” to see the Loan Condition References that have been automatically created

Please make sure that you are viewing “All” Loan Condition References

  1. Take a moment to examine the contents of the "Borrower Label" and "Borrower Description" columns. These entries represent what your borrowers will encounter if any of these conditions occur on their loans.

  2. To modify the Borrower Label, select the pencil icon next to the value you wish to edit. To modify the Borrower Description, please click into the reference record.

  3. Click the blue ☑️ next to “Take Me to Preloaded Loan Conditions” to complete this step.

✅ Enable UWM Integration

  1. Now please configure the Integrations. Be sure to put a valid email address for error notifications. Common errors to look out for are Loan Numbers that are typed incorrectly into Salesforce.

  2. Enter the following details to enable the integration:

    1. CanConditionQueueRun: Active

    2. CanInsightsQueueRun: Active

    3. Condition Batch Size: 5

    4. Default Condition Name: UWM Condition

    5. Insights Batch Size: 25

  3. Click “Schedule Jobs” and then click "Save."

🪟Overview

You've successfully integrated with UWM, ensuring operational efficiency. You prepared essential details, aligned loan stages, set up branches, customized borrower labels, and established default labels. The next step is to build milestones to further enhance your mortgage management process and borrower communication. Click here for step three!

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.