Skip to main content

Loan Officer API

Prior to implementing an iFrame integration, the LOS must develop the following methods to allow Lender Price to retrieve loan officer information from the LOS client.

Get Loan Officer

This method is required by Lender Price as part of the authentication process of the LOS client.

Method: GET

Relative Path: /loan-officer/{username}?context=string

Path Parameters:

ParameterDescription
usernameThis is the username of the LOS loan officer initiating the iFrame session on Lender Price. This value is passed in by the requesting loan officer in the ext_user_id field during Authentication. For additional information, refer to LOS Authentication.

Sample Response Payload:

{
username: string;
firstname: string?;
lastname: string?;
enabled: boolean;
phone: string?;
email: string;
nmlsId: string?;
groups: {
id: string
}[];
companyName: string?;
}

Get Loan Officer by Loan ID

This method retrieves loan officer information for a loan specified by its unique loan ID number.

Method: GET

Relative Path: /loan-officer-by-loan-Id/{loanId}?context=string

Path Parameters:

ParameterDescription
loanIdUnique LOS loan ID of the loan for which loan officer information is being requested. This value is passed in by the requesting loan officer in the ext_user_id field during Authentication. For additional information, refer to LOS Authentication.

Sample Response Payload:

{
username: string;
firstname: string?;
lastname: string?;
enabled: boolean;
phone: string?;
email: string;
nmlsId: string?;
groups: {
id: string
}[];
companyName: string?;
}