This request creates an Agent User profile.
Click here to learn more about this request
Agent User profiles represent the users who have access to your LoanPro environment. Note the following when creating Agent User profiles:
Creating an Agent User profile invites a user to your environment. A successful request will result in an email invitation being sent to the email address associated with the profile.
Agent User profiles control the access a user has to your environment. LoanPro's access controls allow for very precise configurations—even down to the individual buttons within the UI and specific endpoints of the API. This type of access is controlled by the user's assigned Role, which is mandatory when creating a user. LoanPro access can also be controlled by "groups", which provide access to portions of specific features like Agent Walkthroughs, Quick Actions, and more. Here's a breakdown of how the settings within the payload of this request affect the user's access:
| Payload Parameter | Access Setting Name | Type of Access |
|---|---|---|
roleId | Role-Based Access | Access to specific pages and buttons within the UI Access to specific endpoints and methods within the API |
searchRestrictionsGroupId | Search Restriction Groups | Restricts certain accounts from displaying in search results of the Loan Manager and Line of Credit Manager |
searchRestrictionsScGroupId | Search Restriction Groups (Source Companies) | Restricts certain Source Companies from displaying in search results |
defaultUserLoanId | New Account Default Settings | Provides default configurations for new loan accounts created by the user |
shortcutsSetId | Shortcut Sets | Provides pre-determined sets of shortcuts for servicing tasks on the loan summary page. Please note: Shortcuts only apply to the now deprecated, legacy loan summary page. |
ipRestrictionId | IP-Based Access | Restrict access to the entire software based on the user's current IP address. |
loanSummaryTemplateId | Loan View Groups | Provides access to a set of dynamic Loan Views, which are account summary pages that change based on the status of the account. |
smartPanelGroupId | Smart Panel Groups | Provides access to a set of Smart Panel configurations, which are customizable sidebars that display account information. |
wizardGroupId | Walkthrough Groups | Provides access to a set of Agent Walkthroughs, which are configurable guides that help agents complete processes on loan accounts. |
quickActionGroupId | Quick Action Groups | Provides access to a set of Quick Actions, which are Configurable guides that help agents complete manual and automated tasks on line of credit accounts. |
For an example of how Agent Users are created within the UI, take a look at our Agent Users article.
{
"firstName": "John",
"lastName": "Doe",
"userName": "john.doe@email.com",
"roleId": 107038,
"roleType": "tenant",
"tenantAccessActive": 1,
"active": 1,
"gender": "user.gender.male",
"recoveryEmail": "john.doe2@email.com",
"phone": "8015551234",
"jobTitle": "Project Manager",
"searchRestrictionsGroupId": 2,
"searchRestrictionsScGroupId": 3,
"defaultUserLoanId": 1,
"shortcutsSetId": 1,
"ipRestrictionId": 5,
"loanSummaryTemplateId": 1,
"smartPanelGroupId": 1,
"wizardGroupId": 3,
"quickActionGroupId": 1
}
{
"firstName": "John",
"lastName": "Doe",
"userName": "john.doe@email.com",
"roleId": 107038,
"roleType": "tenant",
"tenantAccessActive": 1,
"active": 1
}