Setup

Before starting the integration, complete all four setup steps in order. Each step must be finished before moving to the next.

Step 1: Enable Ocrolus services in MeridianLink

This step requires two actions: raising a support ticket with MeridianLink and enabling Ocrolus as a vendor in the MeridianLink Admin portal.

Raise a MeridianLink support ticket

Contact the MeridianLink support team with the Webhook URL, Username, and Password supplied by Ocrolus. In the same ticket, ask MeridianLink to:

  • Configure the Ocrolus integration for the production environment using the credentials provided by the Ocrolus team. The Ocrolus Demo environment is not required.
  • Whitelist the webhook URL provided by Ocrolus to enable event notifications and integration workflows.

Once MeridianLink completes the configuration and whitelisting, share the MeridianLink Client ID with Ocrolus.

💡

Tip

The support ticket process is handled independently by each client. The exact steps MeridianLink Support performs internally may vary. Follow any instructions MeridianLink provides during this process.

Enable Ocrolus as a vendor

  1. Go to Admin > Company Setup > General Settings > Services.
  2. Click Configure API Access.
  3. Check the box next to Ocrolus.
  4. Click Save.

Enable API access for the user

On the same user account, enable the following permissions:

  • Allow accessing APIs
  • Allow editing non-assigned loans
  • Allow viewing eDocs
  • Allow editing eDocs

Important

Without these permissions, the user and Ocrolus acting on behalf of that user cannot access the MeridianLink APIs, even if the steps above were completed. The user must also have access at the corporate level.


Step 2: Configure the MeridianLink event webhook

This step is required to enable automatic document ingestion when loan events occur in MeridianLink. The webhook must be configured in the MeridianLink Admin portal under Admin > Company Setup > Event Integrations.

  1. Log in to the MeridianLink Admin portal with an admin account.

  2. Navigate to Admin > Company Setup > Event Integrations.

  3. Create a new event integration and configure the webhook URL provided by
    Ocrolus. For example. https://<environment-domain>/webhook .

  4. Select the loan and document fields that should trigger ingestion.

  5. Save the integration configuration.

Production URL whitelisting

Before the production webhook can receive events, MeridianLink must review and whitelist the production URL. Submit a support request to MeridianLink requesting domain review and approval for the production webhook endpoint.


Step 3: Map Ocrolus users to MeridianLink users

Each MeridianLink employee who will use the Ocrolus integration must be mapped to their corresponding Ocrolus account.

  1. Log in to the MeridianLink Admin portal with an administrator account.
  2. Navigate to Admin > Company Setup > Employees.
  3. Select an employee.
  4. Open the Credentials tab.
  5. Add the corresponding Ocrolus account email address for that employee.
  6. Click Save.
  7. Send the verification email to the new user from the Employees editor in MeridianLink Mortgage to complete their One Gateway login setup. This step is required for the new user's API credentials to authenticate successfully. Skipping it will result in OAuth token generation failures.
  8. Verify that the new API user account has all required API permissions enabled in MeridianLink. Missing permissions will also cause OAuth authentication to fail. Contact MeridianLink Support if any permissions are absent.
  9. Repeat these steps for every employee who will use the Ocrolus integration.

Important

Sending the verification email in step 7 is required for the new user's API credentials to authenticate successfully. Skipping it results in OAuth token generation failures. Missing API permissions also cause OAuth authentication to fail. Contact MeridianLink Support if any permissions are absent.

📘

Note

Every MeridianLink user who accesses the Ocrolus integration must have their corresponding Ocrolus account email configured in the Credentials tab. This mapping allows Ocrolus to correctly associate actions with the appropriate MeridianLink user.


Step 4: Configure document folder mapping

Share the following information with Ocrolus:

  • The list of MeridianLink folders from which documents should be ingested by Ocrolus.
  • The destination MeridianLink folders where documents should be written back after classification.

Classification mapping process

  1. Confirm ingestion folders. Identify which eDocs folders Ocrolus should pull documents from.
  2. Retrieve the full eDocs folder list. Once the connection is established, pull all available eDocs folder locations from the MeridianLink instance.
  3. Run the AI mapping tool. Pass the eDocs folder list through the AI mapping tool, which automatically suggests mappings to Ocrolus-supported document types.
  4. Review and sign off. Share the proposed mapping, adjust any mismatches, and get sign-off before finalising.

For each document type, provide the following details. This information is used to configure document ingestion rules, classification mappings, and write-back folder routing between Ocrolus and MeridianLink.

RequirementExample
Source MeridianLink eDocs folder nameIncome Documents
Expected Ocrolus form typePaystub / Bank Statement / W2
Destination MeridianLink eDocs folder namePaystubs / Bank Statements / Tax Documents

Example mapping

Source folderClassified asWrite-back folder
Income DocumentsPaystubPaystubs
Income DocumentsBank StatementBank Statements
Income DocumentsW2Tax Documents

Did this page help you?