Pricing by User or Branch

When integrating with the Lender Price API, a single admin API user authenticates all requests (via JWT or API token). To retrieve pricing on behalf of different users or branches, the admin user passes an impersonation context in search.accessCriteria.userContext.

This allows the admin API user to price as if they were a specific loan officer, branch, or group — without each user needing their own API credentials.

note

The identifiers in userContext (such as userId, username, or userEmail) refer to the user being impersonated — not the admin API user making the request.

By User ID

Impersonate a user by their internal Lender Price ID.

"accessCriteria": {
  "userContext": {
    "userId": "65579be44999c40001ac6a5f"
  }
}

By Username

Impersonate a user by their login username.

"accessCriteria": {
  "userContext": {
    "username": "johndoe"
  }
}

By Email

Impersonate a user by their email address.

"accessCriteria": {
  "userContext": {
    "userEmail": "johndoe@lenderprice.com"
  }
}

By Branch

Price as a branch (or group) instead of an individual user. Branches are created within User Groups in the Lender Price admin panel. Each branch has an external ID that you reference in the API request.

This is useful when pricing should reflect the rate sheets, adjustments, and compensation plans assigned to a branch rather than a specific loan officer.

"accessCriteria": {
  "userContext": {
    "groupType": "Absolute",
    "groups": [
      {
        "externalId": "1234"
      }
    ]
  }
}

Field	Description
groupType	Set to "Absolute" to use the branch's configuration directly.
groups[].externalId	The external ID of the branch/group as configured in User Groups.