Lender Endpoints

Here you'll find documentation on all available endpoints. If you have suggestions on new endpoints you would like to see, please tell us. We would love to hear from you.

Required Parameters

All endpoints require that you provide the following parameters via HTTPS POST:

POST /access-token

The /access-token endpoint will create a new access token if a current access token does not exist, or it will update the current access token if a current access token exists. Access tokens are unique and are set to expire in 25 days. Be sure to refresh your access token using this endpoint.

Tip: A common scenario is to use this endpoint to power single-sign-on within your own application.

Example Request

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/access-token" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will always contain one access token.

{
     "accessToken":"gUS2j4hD6Op2lCtghYJ1gDwH0kms4utaap1knyuw",
     "date":1443566713,
     "expiration":1445726713,
     "ip":"127.0.0.1",
     "deviceID":"bsm-1153447f3d05799984b25325452d627a67d02eff378d0226c97424f74d158e23"
}

The /access-token endpoint will return the following properties:

Possible Error Codes & Messages

POST /access-token/destroy

The /access-token/destroy endpoint will completely destroy the requested access token. Once executed, this process cannot be undone.

This endpoint also requires the accessToken parameter as follows:

Example Request

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/access-token/destroy" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return null if successful, and return the root key error if not. See Error Codes and Handling.

Possible Error Codes & Messages

POST /broker-setup-url

The /broker-setup-url endpoint will create a new session and redirect that session to the broker setup process. This endpoint also requires the following parameters:

JSON Payload Example

{ "loggedInUserUID": "Da4W7mNZ", "company": { "brokerUID": "aYF1VBsd46alkI3KD", "name": "ABC Mortgage Company", "nameLegal": "ABC Mortgage Company, Inc. dba ABC Loans", "addressStreet": "16892 Bolsa Chica Street", "addressStreet2": "#201", "addressCity": "Huntington Beach", "addressState": "CA", "addressZipcode": "92649", "addressCounty": "Orange", "addressCountry": "USA", "website": "https://www.abcloans.com", "phone": "8888888888", "phoneExtension": "12345", "email": "info@abcloans.com", "nmls": "012345", "originatorType": "Broker", "organizationType": "Corporation", "about": "ABC Mortgage is a mortgage firm in California.", "aboutShort": "ABC Mortgage is a great local lender.", "tin": "111223333", "loCompensation": "1.00", "pricingTier": "Tier AAA", "productTypesOffer": { "conventional": "1", "fha": "1", "va": "0" }, "logo": { "imageFormat": "jpg", "base64": "\/9j\/4AAQSkZJRgABAQEAS...9yqOJTGf\/\/Z" }, "favicon": { "imageFormat": "png", "base64": "iVBORw0KGgB+w5jeLawv8DL...fkTd2FK5CYII=" }, "licensing": [{ "state": "CA", "licenseNum": "09876" }, { "state": "NV", "licenseNum": "76543" }, { "state": "TX", "licenseNum": "n/a" }] }, "users": [{ "userUID": "Da4W7mNZ", "timezone": "America/Los_Angeles", "headshot": { "imageFormat": "jpg", "base64": "\/9j\/4Q+eRXhpZgAATU0AKgAA...AEAE2\/9k=" }, "firstName": "Adam", "lastName": "Smith", "phonePrimary": "714-235-7114", "phoneExtension": "12345", "email": "adam.smith@abcloans.com", "role": "Admin", "loanOfficer_nmls": "012345", "licensing": [{ "state": "CA", "licenseNum": "334455" }, { "state": "NV", "licenseNum": "776655" }, { "state": "TX", "licenseNum": "n/a" }] }, { "userUID": "G2bdThp9", "timezone": "America/Los_Angeles", "firstName": "Samantha", "firstNamePreferred": "Sam", "lastName": "Jones", "phonePrimary": "818-859-8285", "phoneExtension": "12345", "email": "samantha.jones@abcloans.com", "role": "Admin/Loan Officer", "loanOfficer_nmls": "010101", "licensing": [{ "state": "CA", "licenseNum": "224466" }, { "state": "NV", "licenseNum": "997755" }, { "state": "TX", "licenseNum": "n/a" }] }] }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/broker-setup-url" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return BeSmartee lenderID, a URL to the broker setup process if successful, a set up process status flag and a list of users with your userUID and BeSmartee userID. redirectURL will be null if the logged in user is not the person who started the set up process, or if the process has been completed.

The flag isSetUpCompleted will be 0 if process has NOT been completed, and 1 if the process has been completed. Response will return the root key error if any error. See Error Codes and Handling.

{ "lenderID": "LENDER_ID", "redirectURL": "https://www.besmartee.com/lender/sign-up/start-basic? lenderID=LENDER_ID", "isSetUpCompleted": 0, "users": [ { "userID": "774EE1F9", "userUID": "Da4W7mNZ" }, { "userID": "GNNL88BR", "userUID": "G2bdThp9" } ] }

Possible Error Codes & Messages

POST /connect-vendor

The /connect-vendor endpoint will establish a connection between a vendor integrated with BeSmartee and the lender organization using the API. This will enable the vendor to utilize partner API endpoints with the lender organization. This endpoint also requires the following parameter(s):

JSON Payload Example

{ "vendor": "ABCD1234", "allowLoanLevelAccess": true, "allowBrokerAccess": true }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/broker-setup-url" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return a JSON object containing success status.

The JSON data will contain an error object if the API is not successful

{ "success": true }

Possible Error Codes & Messages

POST /set-signup-product-pricing

The /set-signup-product-pricing endpoint will return a product and pricing unique identifier that may be used to bypass the loan search and loan product & pricing at the signup page. You must pass in search parameters and the resulting loan product and pricing being applied for. This endpoint requires the following parameters:

JSON Payload Example

{ "borrower" : { "firstName" : "Charles", "lastName" : "Cooper", "dob" : "10/22/1968", "phonePrimary" : "7142458223", "phoneSecondary" : "7142357114", "status" : "Married", "primaryAddressStreet" : "16892 Bolsa Chica St", "primaryAddressCity" : "Huntington Beach", "primaryAddressState" : "CA", "primaryAddressZipcode" : "92649", "email" : "charlescooper@mail.com", "autoCheckTOUPP": 1, "isCreateLeadInPipeline": 1 }, "loan": { "subjectPropertyAddressStreet" : "5361 Bonanza Dr", "subjectPropertyAddressCity" : "Huntington Beach", "subjectPropertyAddressState" : "CA", "subjectPropertyAddressZipcode" : "92649", "loanPurpose": "RefinanceCashOut", "lockPeriod": "30", "homePrice": "500000", "downPayment": "250000", "cashOut": "10000", "fico": "750", "grossMonthlyIncome": "5000.00", "monthlyDebts": "951.62", "propertyType": "SingleFamily", "occupancyType": "PrimaryResidence", "bankruptcy": "0", "foreclosure": "0", "noImpounds": "0", "firstTimeBuyer": "1", "employmentStatus": "FullTime", "documentationType": "Full", "numberHomesOwned": "0", "financeUFMIP": "0", "flip": "0", "streamline": "0", "productProgram": "Conventional", "loanAmortizationType": "AdjustableRate", "loanAmortization": "30", "armType": "7/1", "armIndexMargin": "2.25", "armCapRates": "5/2/5", "lpmi": "0", "hpml": "0", "rate": "4.500", "apr": "4.552", "monthlyPayment": "1315.84", "discountPointPercent": "-1.00", "discountPoint": "-2600.00", "advertisingCampaignProviderID": "53781", "advertiserID": "4edzbe0c-aa81-4181-a5cf-cef9062a4cea", "loanOfficerUID" : "6ETBTZ4N", "campaignID" : "N4X7UY4N" } }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/set-signup-product-pricing" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

{"signUpURL":"https://www.besmartee.com/app/signup/p/smartmortgage/r/GEU5229JCL3Z?leadReferralSource=K8ZW5BJM","bsmLeadUID":"K8ZW5BJM"}

Response will return signUpURL and bsmLeadUID if successful, and return the root key error if not. See Error Codes and Handling.

Possible Error Codes & Messages

GET /app-signup

The /app-signup "endpoint" is not so much an endpoint as it is instructions how to pass additional parameters when a consumer is signing up for an account with you. This is commonly used when you have already collected basic information and you wish to pre-populate this data so the consumer is not asked to key in redundant information they provided previously.

The below parameters can be passed as GET parameters added to your unique signup URL:

Example Request

https://app.yourdomain.com/app/signup/partner/YOURUID?firstName=Sparky& lastName=Testcase&phonePrimary=555-555-5555

Response Format

Response will load the signup page whether successfully or not. You can tell if it's successful if throughout the loan application you see pre-populated data as expected

POST /email-application

The /email-application endpoint will email a borrower with a sign up URL. The generated URL is specific to a loan officer, and may also be linked to an optional "loan applied for" by passing in the loan object. The borrower, who will receive the email, will be recognized based on publicID parameter. If there is no publicID, and new borrower will be created based on borrowers parameter. This endpoint requires the following parameters:

JSON Payload Example

{ "company": { "lenderID": "6SGKSI3X" }, "user": { "userUID": "Da4W7mNZ" }, "publicID": "ABC1223", "borrowers" : [ { "borrowerUID" : "12001", "firstName" : "Charles", "lastName" : "Cooper", "dob" : "10/22/1968", "phonePrimary" : "7142458223", "phoneSecondary" : "7142357114", "status" : "Married", "marriedToBorrowerUID" : "12002", "primaryAddressStreet1" : "16892 Bolsa Chica St", "primaryAddressStreet2" : "#201", "primaryAddressCity" : "Huntington Beach", "primaryAddressState" : "CA", "primaryAddressZipcode" : "92649", "email" : "charlescooper@mail.com", "isPrimary": 1 }, { "borrowerUID" : "12002", "firstName" : "Mary", "lastName" : "Cooper", "dob" : "10/22/1974", "phonePrimary" : "7146067748", "phoneSecondary" : "7149902021", "status" : "Married", "marriedToBorrowerUID" : "12001", "primaryAddressStreet1" : "16892 Bolsa Chica St", "primaryAddressStreet2" : "#201", "primaryAddressCity" : "Huntington Beach", "primaryAddressState" : "CA", "primaryAddressZipcode" : "92649", "email" : "marycooper@mail.com", "isPrimary": 0 } ], "loan": { "loanID": "LQCT0AK8", "subjectPropertyAddressStreet1" : "5361 Bonanza Dr", "subjectPropertyAddressStreet2" : "", "subjectPropertyAddressCity" : "Huntington Beach", "subjectPropertyAddressState" : "CA", "subjectPropertyAddressZipcode" : "92649", "loanPurpose": "RefinanceCashOut", "lockPeriod": "30", "homePrice": "500000", "downPayment": "250000", "cashOut": "10000", "fico": "750", "grossMonthlyIncome": "5000.00", "monthlyDebts": "951.62", "propertyType": "SingleFamily", "occupancyType": "PrimaryResidence", "bankruptcy": "0", "foreclosure": "0", "noImpounds": "0", "firstTimeBuyer": "1", "employmentStatus": "FullTime", "documentationType": "Full", "numberHomesOwned": "0", "financeUFMIP": "0", "flip": "0", "streamline": "0", "productProgram": "Conventional", "loanAmortizationType": "AdjustableRate", "loanAmortization": "30", "armType": "7/1", "armIndexMargin": "2.25", "armCapRates": "5/2/5", "lpmi": "0", "rate": "4.500", "apr": "4.552", "monthlyPayment": "1315.84", "discountPointPercent": "-1.00", "discountPoint": "-2600.00", "businessChannel": "Wholesale" } }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/email-application" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return null if successful, and return the root key error if not. See Error Codes and Handling.

Possible Error Codes & Messages

POST /update-headshot

The /update-headshot endpoint allows you to add or update user headshots. This endpoint requires the following parameters:

JSON Payload Example

{ "company": { "lenderID": "6SGKSI3X" }, "users": [{ "userUID": "Da4W7mNZ", "headshot": { "imageFormat": "jpg", "base64": "\/9j\/4Q+eRXhpZgAATU0AKgAA...AEAE2\/9k=" } }, { "userUID": "G2bdThp9", "headshot": { "imageFormat": "jpg", "base64": "\/9j\/4AAQSkZJRgABAQEAS9yq...OJTGf\/\/Z" } }] }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/update-headshot" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return null if successful, and return the root key error if not. See Error Codes and Handling.

Possible Error Codes & Messages

POST /set-account-status

The /set-account-status endpoint allows you to deactivate or activate any one or more valid lender(s) and/or user(s). If you deactivate or activate a lender, all users linked to that lender will also be deactivated or activated. This endpoint requires the following parameters:

JSON Payload Example

{ "companies": [ { "lenderID": "6SGKSI3X", "status": "Deactivate" }, { "lenderID": "IHX4SFKS", "status": "Deactivate" } ], "users": [ { "userUID": "H92dE5b9", "status": "Deactivate" }, { "userUID": "7t9D2MeE", "status": "Deactivate" }, { "userUID": "5tXx2rEG2", "status": "Activate" } ] }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/set-account-status" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return null if successful, and return the root key error if not. See Error Codes and Handling.

Possible Error Codes & Messages

POST /add-users

The /add-users endpoint will add one or more users to a specified lender. If a user already exists (duplicate email) this endpoint will update that user. This endpoint also requires the following parameters:

JSON Payload Example

{ "company": { "lenderID": "6SGKSI3X" }, "users": [{ "userUID": "Da4W7mNZ", "timezone": "America/Los_Angeles", "headshot": { "imageFormat": "jpg", "base64": "\/9j\/4Q+eRXhpZgAATU0AKgAA...AEAE2\/9k=" }, "firstName": "Adam", "lastName": "Smith", "phonePrimary": "714-235-7114", "phoneExtension": "12345", "email": "adam.smith@abcloans.com", "role": "Admin", "loanOfficer_nmls": "012345", "primaryBranchID": "TIDHLHOP", "secondaryBranchIDs": ["TYHAOPOK", "PQAMLALD"], "licensing": [{ "state": "CA", "licenseNum": "334455" }, { "state": "NV", "licenseNum": "776655" }, { "state": "TX", "licenseNum": "n/a" }] }, { "userUID": "G2bdThp9", "timezone": "America/Los_Angeles", "firstName": "Samantha", "lastName": "Jones", "phonePrimary": "818-859-8285", "phoneExtension": "12345", "email": "samantha.jones@abcloans.com", "role": "Admin/Loan Officer", "loanOfficer_nmls": "010101", "primaryBranchID": "PQAMLALD", "secondaryBranchIDs": ["TYHAOPOK"], "licensing": [{ "state": "CA", "licenseNum": "224466" }, { "state": "NV", "licenseNum": "997755" }, { "state": "TX", "licenseNum": "n/a" }] }] }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/add-users" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return the brokerUID of the input company, a list of your UIDs (userUID), BeSmartee's IDs (userID) for each user if successful. Response will return the root key error if any error. See Error Codes and Handling.

{ "brokerUID": "aYF1VBsd46alkI3KD", "users": [ { "userID": "LTV1OH28", "userUID": "Da4W7mNZ" }, { "userID": "HSQLSFD9", "userUID": "G2bdThp9" } ] }

Possible Error Codes & Messages

POST /update/user

The /update/user endpoint will update a User borrower. This endpoint also requires the following parameters:

JSON Payload Example

{ "userID": "[User ID]", "email": "alice.firstimer@besmartee.com", "user": { "prefEmailNotifications": 0 } }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/update/user" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will return null if successful, and return the root key error if not. See Error Codes and Handling.

POST /get-single-sign-on-url

The /get-single-sign-on-url endpoint will generate a single-sign-on URL for the input user. This single-sign-on URL will become invalid once user logs in via the URL. This endpoint requires the following parameters:

JSON Payload Example

{ "company": { "lenderID": "4G7230D6" }, "user": { "userID": "QZCJNMI2" } }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/get-single-sign-on-url" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

If the broker has not completed the set up process and the requesting user should continue the process, return URL to finish the process under the key signOnURL.
If the broker has not completed the set up process, return null (empty string) for other users.
If the broker completed their set up process, response will return the single-sign-on URL under the key signOnURL.
Response will return the root key error if any error. See Error Codes and Handling.

{ "signOnURL": "https://www.besmartee.com/lender/single-sign-on/4oW41zt9xLb oXjY8cWIeaxW8XD0wvVYJx7jT2zRa3BR2e" }

Possible Error Codes & Messages

POST /get-apr-closing-costs

The /get-apr-closing-costs takes loan search criteria and loan products in order to figure out the APR and closing costs/fees for each loan product.

JSON Payload Example 1

{ "options" : { "isReturnSchedule" : false }, "search" : { "loanPurpose" : "Purchase", "zipcode" : "92649", "city" : "Huntington Beach", "county" : "Orange", "countyFips" : "06059", "state" : "CA", "homePrice" : "200000", "downPayment" : "40000", "loanAmount" : "160000", "propertyType" : "SingleFamily", "numUnits" : "1", "buildingStatus" : "Existing", "occupancyType" : "PrimaryResidence", "noImpounds" : "1", "streamline" : "0", "financeUFMIP" : "0", "financeVAFF" : "0", "financeUSDAGuaranteeFee" : "0" }, "products": [ { "productProgram" : "Conventional", "loanTerm" : "30", "loanAmortizationType" : "Fixed", "loanAmortization" : "3", "interestOnly" : "0", "lpmi" : "1", "rates" : [ { "rate" : "2.250", "points" : "-1.750", "isHPML" : "0" }, { "rate" : "3.500", "points" : "0.00", "isHPML" : "0" }, { "rate" : "4.500", "points" : "2.00", "isHPML" : "1" } ] }, { "productProgram" : "Conventional", "loanTerm" : "5", "loanAmortizationType" : "AdjustableRate", "loanAmortization" : "30", "interestOnly" : "0", "lpmi" : "0", "armIndex" : "LIBOR", "armIndexMargin" : "2.250", "armFirstAdj" : "60", "armFirstAdjCap" : "5", "armPerAdj" : "12", "armPerAdjCap" : "2", "armLifeCap" : "5", "rates" : [ { "rate" : "3.500", "points" : "-0.250", "isHPML" : "0" }, { "rate" : "2.750", "points" : "1.00", "isHPML" : "0" } ] } ] }

JSON Payload Example 2

{ "search" : { "loanPurpose" : "RefinanceCashOut", "zipcode" : "92649", "homePrice" : "600000", "cashOut" : "50000", "loanAmount" : "200000", "propertyType" : "SingleFamily", "numUnits" : "1", "buildingStatus" : "Existing", "occupancyType" : "PrimaryResidence", "noImpounds" : "1", "streamline" : "1", "financeUFMIP" : "0", "financeVAFF" : "1", "financeUSDAGuaranteeFee" : "0" }, "products": [ { "productProgram" : "VA", "loanTerm" : "30", "loanAmortizationType" : "Fixed", "loanAmortization" : "30", "interestOnly" : "0", "lpmi" : "1", "rates" : [ { "rate" : "2.250", "points" : "1.250", "isHPML" : "0" }, { "rate" : "3.000", "points" : "0.00", "isHPML" : "0" }, { "rate" : "4.500", "points" : "-2.00", "isHPML" : "1" } ] } ] }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/get-apr-closing-costs" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

The response will include every loan product that was sent in the request with a similar structure.   Each set of rates will include the calculated APR and each rate will include an array of fees products.rates.fees.

Response will return the root key error if any error. See Error Codes and Handling.

{ "status" : "success", "products": [ { "productProgram" : "Conventional", "loanTerm" : "30", "loanAmortizationType" : "Fixed", "loanAmortization" : "30", "interestOnly" : "0", "lpmi" : 1, "rates" : [ { "rate" : "2.250", "points" : "-1.750", "isHPML" : "0", "apr" : "4.050", "fees" : [ { "name" : "Origination Fee", "fee" : "500.00", "percent" : "", "mismoType" : "LoanOriginationFee", "mismoTypeOther" : "", "leSection" : "A" }, { "name" : "Title - Tax Review Fee", "fee" : "62.00", "percent" : "", "mismoType" : "Other", "mismoTypeOther" : "", "leSection" : "C" }, { "name" : "Appraisal", "fee" : "515.00", "percent" : "", "mismoType" : "AppraisalFee", "mismoTypeOther" : "", "leSection" : "B" } ] }, { "rate" : "3.500", "points" : "0.00", "isHPML" : "0", "apr" : "3.790", "fees" : [ { "name" : "Origination Fee", "fee" : "500.00", "percent" : "", "mismoType" : "LoanOriginationFee", "mismoTypeOther" : "", "leSection" : "A" }, { "name" : "Title - Tax Review Fee", "fee" : "62.00", "percent" : "", "mismoType" : "Other", "mismoTypeOther" : "", "leSection" : "C" }, { "name" : "Appraisal fee", "fee" : "515.00", "percent" : "", "mismoType" : "AppraisalFee", "mismoTypeOther" : "", "leSection" : "B" } ] }, { "rate" : "4.500", "points" : "2.00", "isHPML" : "1", "apr" : "4.750", "fees" : [ { "name" : "Origination Fee", "fee" : "500.00", "percent" : "", "mismoType" : "LoanOriginationFee", "mismoTypeOther" : "", "leSection" : "A" }, { "name" : "Title - Tax Review Fee", "fee" : "62.00", "percent" : "", "mismoType" : "Other", "mismoTypeOther" : "", "leSection" : "C" }, { "name" : "Appraisal fee", "fee" : "515.00", "percent" : "", "mismoType" : "AppraisalFee", "mismoTypeOther" : "", "leSection" : "B" } ] } ] }, { "productProgram" : "Conventional", "loanTerm" : 5, "loanAmortizationType" : "AdjustableRate", "loanAmortization" : "30", "interestOnly" : "0", "lpmi" : "0", "armIndex" : "LIBOR", "armIndexMargin" : "2.250", "armFirstAdj" : "60", "armFirstAdjCap" : "5", "armPerAdj" : "12", "armPerAdjCap" : "2", "armLifeCap" : "5", "rates" : [ { "rate" : "3.500", "points" : "-0.250", "isHPML" : "0", "apr" : "3.800", "fees" : [ { "name" : "Loan Origination Fee", "fee" : "500.00", "percent" : "", "mismoType" : "LoanOriginationFee", "mismoTypeOther" : "", "leSection" : "A" }, { "name" : "Title - Tax Review Fee", "fee" : "62.00", "percent" : "", "mismoType" : "Other", "mismoTypeOther" : "", "leSection" : "C" }, { "name" : "Appraisal fee", "fee" : "515.00", "percent" : "", "mismoType" : "AppraisalFee", "mismoTypeOther" : "", "leSection" : "B" } ] }, { "rate" : "2.750", "points" : "1.00", "isHPML" : "0", "apr" : "3.450", "fees" : [ { "name" : "Loan Origination Fee", "fee" : "500.00", "percent" : "", "mismoType" : "LoanOriginationFee", "mismoTypeOther" : "", "leSection" : "A" }, { "name" : "Title - Tax Review Fee", "fee" : "62.00", "percent" : "", "mismoType" : "Other", "mismoTypeOther" : "", "leSection" : "C" }, { "name" : "Appraisal", "fee" : "515.00", "percent" : "", "mismoType" : "AppraisalFee", "mismoTypeOther" : "", "leSection" : "B" } ] } ] } ] }

Possible Error Codes & Messages

POST /get-ppe-anonymous

The /get-ppe-anonymous endpoint takes in search parameters in the query string and returns a list of products, pricing, eligibility and fees from your product & pricing engine (PPE).

JSON Payload Example

{ "channel": "Retail", "subChannel": "Employee", "loanPurpose": [ "RefinanceCashOut" ], "lockPeriod": "30", "zipcode": [ "92649" ], "homePrice": "500000", "downPayment": "250000", "loanAmount": "250000", "cashOut": "10000", "fico": "750", "grossMonthlyIncome": "5000.00", "monthlyDebts": "951.62", "propertyType": "SingleFamily", "numUnits": "1", "buildingStatus": "Existing", "occupancyType": "PrimaryResidence", "bankruptcy": "0", "foreclosure": "0", "noImpounds": "0", "firstTimeBuyer": "1", "employmentStatus": "FullTime", "documentationType": "Full", "numberHomesOwned": "0", "financeUFMIP": "0", "flip": "0", "streamline": "0", "filterARMs": "1", "filterConventional": "1", "filterFHA": "1", "filterVA": "0", "filterHomeReady": "0", "filterUSDA": "0", "filter40Year": "0", "filter30Year": "1", "filter25Year": "0", "filter20Year": "1", "filter15Year": "1", "filter10Year": "1", "filter10YearARM": "1", "filter7YearARM": "1", "filter5YearARM": "1", "filter3YearARM": "0", "filter2YearARM": "0", "filter1YearARM": "0", "filterLess1YearARM": "0", "filterPoints" : { "low" : "-1", "high" : "1" }, "isSecondFinancing": "0", "isStudentLoanCashout": "0", "isTexas50a": "0", "priorLoanIsTexas50a": "0", "ppeID": "173" }

This endpoint can also run a large set of permutations for clients who are looking for bulk pricing, such as a daily nationwide rate card for marketing purposes. You'll need to pass multiple values in the loanPurpose and/or zipcode arrays as such:

{ "loanPurpose": [ "Purchase", "Refinance", "RefinanceCashOut" ], "zipcode": [ "92649", "33154", "10014" ], ... }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/get-ppe-anonymous" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

The response will include list of all eligible loan products being requested for with pricing and fees. Response will return the root key error if any error. See Error Codes and Handling.

{ "status" : "success", "searchID": "4SG21P", "loanPurpose": "Purchase", "zipcode": "90745", "products": [ { "armFirstAdj": 120, "armFirstAdjCap": 5, "armIndex": "LIBOR", "armIndexMargin": 2.25, "armLifeCap": 5, "armPerAdj": 12, "interestOnly": 0, "loanAmortizationType": "AdjustableRate", "loanTerm": 30, "lpmi": 0, "productName": "10/1 LIBOR ARM", "productProgram": "Conventional", "rates": [ { "apr": 4.672, "fees": [ { "fee": 200, "leSection": "A", "mismoType": "ApplicationFee", "mismoTypeOther": null, "name": "Application Fee", "percent": null }, { "fee": 625, "leSection": "A", "mismoType": "LoanDiscountPoints", "mismoTypeOther": null, "name": "Loan discount points", "percent": null }, { "fee": 500, "leSection": "B", "mismoType": "AppraisalFee", "mismoTypeOther": null, "name": "Appraisal Fee", "percent": null }, { "fee": 40, "leSection": "B", "mismoType": "CreditReportFee", "mismoTypeOther": null, "name": "Credit report", "percent": null }, { "fee": 75, "leSection": "C", "mismoType": "CourierFee", "mismoTypeOther": null, "name": "Title - Courier/Wire Fee", "percent": null }, { "fee": 606, "leSection": "H", "mismoType": "TitleOwnersCoveragePremium", "mismoTypeOther": null, "name": "Title - Owners Title Insurance (optional)", "percent": null } ], "isHPML": 0, "monthlyPayment": 1211.62, "piti": { "principalAndInterest": 486.09, "propertyTaxes": 107.65, "homeownerInsurance": 25.24, "mortgageInsurance": 0, }, "paymentStream": [ { "mortgageInsurance": 0, "numberOfPayments": 120, "principalAndInterest": 1211.63, "startDate": "2018-09-01" }, { "mortgageInsurance": 0, "numberOfPayments": 239, "principalAndInterest": 1198.56, "startDate": "2028-09-01" }, { "mortgageInsurance": 0, "numberOfPayments": 1, "principalAndInterest": 1195.48, "startDate": "2048-08-01" } ], "points": 0.25, "rate": 4.125 }, { "apr": 4.732, "fees": [ { "fee": 200, "leSection": "A", "mismoType": "ApplicationFee", "mismoTypeOther": null, "name": "Application Fee", "percent": null }, { "fee": 500, "leSection": "B", "mismoType": "AppraisalFee", "mismoTypeOther": null, "name": "Appraisal Fee", "percent": null }, { "fee": 40, "leSection": "B", "mismoType": "CreditReportFee", "mismoTypeOther": null, "name": "Credit report", "percent": null }, { "fee": 75, "leSection": "C", "mismoType": "CourierFee", "mismoTypeOther": null, "name": "Title - Courier/Wire Fee", "percent": null }, { "fee": 606, "leSection": "H", "mismoType": "TitleOwnersCoveragePremium", "mismoTypeOther": null, "name": "Title - Owners Title Insurance (optional)", "percent": null }, ], "isHPML": 0, "monthlyPayment": 1229.85, "piti": { "principalAndInterest": 486.09, "propertyTaxes": 107.65, "homeownerInsurance": 25.24, "mortgageInsurance": 0, }, "paymentStream": [ { "mortgageInsurance": 0, "numberOfPayments": 120, "principalAndInterest": 1229.85, "startDate": "2018-09-01" }, { "mortgageInsurance": 0, "numberOfPayments": 239, "principalAndInterest": 1203.53, "startDate": "2028-09-01" }, { "mortgageInsurance": 0, "numberOfPayments": 1, "principalAndInterest": 1201.95, "startDate": "2048-08-01" } ], "points": 0, "rate": 4.25 } ] } ], "watchableLoanPrograms": [ "Conventional 10 Year Fixed", "Conventional 15 Year Fixed", "Conventional 30 Year Fixed" ] }

If using optional method to return a set of bulk pricing permutations with parameters loanPurposes and/or zipcodes, then the products array will be wrapped in a new array called permutations as such:

{ "status": "success", "permutations": [ { "searchID": "4SG21P", "loanPurpose": "Purchase", "zipcode": "33154", "products": { "productProgram": "Conventional", "loanTerm": "30", ... }, "watchableLoanPrograms": [ ... ] }, { "searchID": "4SG21P", "loanPurpose": "Purchase", "zipcode": "33154", "products": { "productProgram": "Conventional", "loanTerm": "15", ... }, "watchableLoanPrograms": [ ... ] } ] }

Below, you'll find details on the data types of the response payload.

Possible Error Codes & Messages

POST /rate-watch

The /rate-watch endpoint will help a consumer can subcribe/unsubcribe a rate-watch from your product & pricing engine (PPE).

JSON Payload Example (action = subcribe, type = REGULAR)

{ "action": "subscribe", "searchID": "PYQB8F", "firstName": "Charles", "lastName": "Cooper", "email": "charlescooper@mail.com", "phone": "817-501-6587", "type": "REGULAR", "frequency": "DAILY", "duration": "ONE_WEEK", "productNames": [ "Conventional 10 Year Fixed", "Conventional 15 Year Fixed" ] }

JSON Payload Example (action = subcribe, type = RATE_TARGET)

{ "action": "subscribe", "searchID": "PYQB8F", "firstName": "Charles", "lastName": "Cooper", "email": "charlescooper@mail.com", "phone": "817-501-6587", "type": "RATE_TARGET", "rateTargets": [ { "productName": "Conventional 10 Year Fixed", "desiredRate": "4%" }, { "productName": "Conventional 15 Year Fixed", "desiredRate": "3.50%" } ] }

JSON Payload Example (action = unsubcribe)

{ "action": "unsubscribe", "token": "6qjoEOCXYhlD7HnK9kN8gII4tuermNntGbvRqbpMtw1STLGomiy6tYLQhPh9", }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/rate-watch" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

The response will return details of rate watch you register to subscribe. Response will return the root key error if any error. See Error Codes and Handling.

{ "status": "success", "rateWatch": { "firstName": "Charles", "lastName": "Cooper", "email": "charlescooper@mail.com", "phone": "817-501-6587", "type": "RATE_TARGET", "frequency": "DAILY", "expiration": 1577518614, "date": 1561966614, "unsubscribeToken": "2bOLcpdL0HDvLJQQBJtMSacDPmwKngzqvPjIai02lr9A1SLwCxoILmfcGHwD" }

Below, you'll find details on the data types of the response payload.

Possible Error Codes & Messages

POST /get-list-loans

The /get-list-loans endpoint will return a list of loans. By default, return list is limited to 1,000 loans. If you need a higher return limit, please contact your Account Manager with a business case for an increase request. This endpoint also requires the following parameters:

JSON Payload Example

{ "isActive" : "true", "action" : "DateRange", "dateFrom" : "01/01/2017", "dateTo" : "01/31/2017", "userID" : "ABCD1234", "sortBy" : "desc", "limit" : 1000, "offset" : 1, "userEmail" : "john.smith@gmail.com", "filter": { "status": { "archived": { "since": 240 }, "withdrawn": { "since": 240 } }, "property": { "state": "CA" }, "wholesaleLenderUID" : "TVDG4JDI", "loanOfficer": { "loanOfficerUID": "EYKSHL3G" }, "timestampLastModified" : 1735718400 }, "withBorrower": [ "email", "ssoID", "firstName", "middleName", "lastName", "isPrimary" ] }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/get-list-loans" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will list of loans if successful. Response will return the root key error if any error. See Error Codes and Handling.

{ "totalCount": 10 "loans": [ { "date" : 1543222451, "ID" : "NINWCRRA", "statusDate" : 1543223044, "systemMainStatus" : "Loan Approval", "systemSubStatus" : "Submitted Application", "lenderMainStatus" : "Submitted to LOS", "lenderSubStatus" : "Ran AUS", "borrowerMainStatus" : "Submitted to LOS", "borrowerSubStatus" : "Ran AUS", "closingDate": null, "loanPurpose":"Purchase", "productProgram":"Conventional", "occupancyType" : "PrimaryResidence", "propertyType": "SingleFamily", "homePrice":"200000", "loanAmount" : "160000", "totalBorrowersMonthlyIncome": "5000.00", "totalBorrowersLiabilities": "50000.00", "subjectPropertyStreet": "16892 Bolsa Chica Street", "subjectPropertyStreet2": "#201", "subjectPropertyCity": "Huntington Beach", "subjectPropertyState": "CA", "subjectPropertyZipcode": "92649", "loanOfficerFirstName": "Adam", "loanOfficerLastName": "Smith", "loanOfficerEmail": "adam@besmartee.com", "loanOfficerUID": "EHDN323A", "borrowers": [{ "firstName": "Charles", "middleName": "Peter", "lastName" : "Cooper", "email": "charlescooper@mail.com", "ssoID": "324213434" "isPrimary":true, }], "loanViews": [{ "name": "Bryan Adams", "userID": "ABCD1234" "time": 1722390680, }], }, { "date" : 1543215505, "ID" : "CZM1EV5F", "statusDate" : 1543215601, "systemMainStatus" : "Loan Approval", "systemSubStatus" : "Chose Loan", "lenderMainStatus" : "Submitted to LOS", "lenderSubStatus" : "Chose Loan", "borrowerMainStatus" : "Submitted to LOS", "borrowerSubStatus" : "Chose Loan", "closingDate": 1545243063, "loanPurpose":"Purchase", "productProgram":"Conventional", "occupancyType" : "PrimaryResidence", "propertyType": "SingleFamily", "homePrice":"200000", "loanAmount" : "160000", "totalBorrowersMonthlyIncome": "5000.00", "totalBorrowersLiabilities": "50000.00", "subjectPropertyStreet": "16892 Bolsa Chica Street", "subjectPropertyStreet2": "#201", "subjectPropertyCity": "Huntington Beach", "subjectPropertyState": "CA", "subjectPropertyZipcode": "92649", "loanOfficerFirstName": "Adam", "loanOfficerLastName": "Smith", "loanOfficerEmail": "adam@besmartee.com", "loanOfficerUID": "EHDN323A", "borrowers": [{ "firstName": "Charles", "middleName": "Peter", "lastName" : "Cooper", "email": "charlescooper@mail.com", "ssoID": "324213434", "isPrimary":false, }], "loanViews": [{ "name": "John Smith", "userID": "GHIJ3456" "time": 1722390680, }], } ] }

Possible Error Codes & Messages

POST /create-notifications

The /create-notifications endpoint will receive a list of event notifications from the CRM and return a list of statuses. This endpoint also requires the following parameters:

JSON Payload Example

[ { "crmEventID": "2000084422", "actionList": [ { "actionType": "createTask", "crmID": "22112183", "actionData": { "taskCRMID": "6df8be86-21c5-4e00-ba76-404625c80bd5", "taskCode": "RequestAction", "taskTargetType": "LenderUser", "taskAssigneeCRMID": "U12345", "taskRequestedByUserCRMID": "U45678", "taskDescription": "Discuss LPA options with the client" } }, { "actionType": "createAlert", "crmID": "22112183", "actionData": { "alertCRMID": "a6e84b98-e295-4efd-868b-f644a1a2a6ce", "alertCode": "RequestAction", "alertTargetType": "Loan", "alertTargetRoles": [ "LoanOfficer", "LoanOfficerAssistant" ], "alertMessage": "Discuss LPA options with the client", "alertSeverity": "Low" } }, { "actionType": "archiveEmail", "crmID": "22102183", "actionData": { "emailCRMID": "6df8be86-21c5-4e00-ba76-404625c80bd5", "emailCode": "completionNotificationToLO", "emailTargetType": "LenderUser", "emailSenderAddress": "smartmortgage@test.com", "emailSenderName": "Smart Mortgage", "emailTimestamp": 1566262068, "emailRecipients": { "toEmailAddresses": [ "lo@test.com" ], "ccEmailAddresses": [], "bccEmailAddresses": [], "replytoAddress": [ "smartmortgage@test.com" ] }, "emailSubject": "New Loan Application from Alice Firstimer", "emailBody": "<p>Hi LoanOfficer<p><p>You have a new loan application.<p>" } }, { "actionType": "sendEmail", "crmID": "22102183", "actionData": { "emailCRMID": "6df8be86-21c5-4e00-ba76-404625c80bd5", "emailCode": "completionNotificationToLO", "emailTargetType": "LenderUser", "emailSenderAddress": "smartmortgage@test.com", "emailSenderName": "Smart Mortgage", "emailRecipients": { "toEmailAddresses": [ "lo@test.com" ], "ccEmailAddresses": [], "bccEmailAddresses": [], "replytoAddress": [ "smartmortgage@test.com" ] }, "emailSubject": "New Loan Application from Alice Firstimer", "emailBody": "<p>Hi LoanOfficer<p><p>You have a new loan application.<p>" } }, { "actionType": "sendSMS", "crmID": "22102183", "actionData": { "smsCRMID": "a6e84b98-e295-4efd-868b-f644a1a2a6ce", "smsCode": "completionNotificationToLO", "smsTargetType": "LenderUser", "smsTargetUserCRMID": "NV38953", "smsToNumber": "9998887777", "smsBody": "New Loan Application from Alice Firstimer" } } ] } ]

Below, you'll find details on all required parameters to be included in the JSON payload.

Below, you'll find details on all required parameters of actionData when actionType=createTask to be included in the JSON payload.

Below, you'll find details on all required parameters of actionData when actionType=createAlert to be included in the JSON payload.

Below, you'll find details on all required parameters of actionData when actionType=archiveEmail to be included in the JSON payload.

Below, you'll find details on all required parameters of actionData when actionType=sendEmail to be included in the JSON payload.

Below, you'll find details on all required parameters of actionData when actionType=sendSMS to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/create-notifications" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will list of notifications if successful.Response will return the root key error if any error. See Error Codes and Handling.

[ { "status": "success", "crmEventID": "2000084422" }, { "status": "success", "crmEventID": "2000084423" } ]

Error Response

[ { "status": "error", "crmEventID": "2000084422", "errorMessage": "Parameter emailTimestamp missing." } ]

Possible Error Codes & Messages

POST /get-internal-users

The /get-internal-users endpoint will return a list of the internal users from your organization based on the user's sub-role. This endpoint also requires the following parameters:

JSON Payload Example

{ "subRole" : "Loan Officer", "branchID" : "4IITBI1P", "licensed" : ["CA", "TX"], "assignable": 1 }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/get-internal-users" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

Response will list of loans if successful. Response will return the root key error if any error. See Error Codes and Handling.

[ { "firstName": "John", "firstNamePreferred": "Jeff", "middleName": null, "lastName": "Person", "phonePrimary": "800-111-2222", "email": "jeff@besmartee.com", "nmls": "010101", "userID": "ABCD1234", "headshotURL": "http://www.besmartee.com/images/..." }, { "firstName": "Dennis", "firstNamePreferred": Charlie, "middleName": null, "lastName": "Human", "phonePrimary": "888-432-1234", "email": "person@besmartee.com", "nmls": "10101101", "userID": "QWERASDF", "headshotURL": "http://www.besmartee.com/images/..." } ]

Possible Error Codes & Messages

POST /create-loan

The /create-loan endpoint will create a new URLA loan. This endpoint also requires the following parameters:

JSON Payload Example

{ "losLoanID": "[LOS LOAN ID]", "mismo34": "[MISMO 3.4]", "inviteBorrowers": 0, "losMiscLoanData": { "loanStatusMain": "Start Application", "loanStatusSub": "Signed Up" } }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/create-loan" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

The response will public loan ID, and return the root key error if not. See Error Codes and Handling.

{ "publicID": "UU473IOJ" }

POST /import-loan

The /import-loan endpoint will create a new URLA loan. This endpoint also requires the following parameters:

JSON Payload Example

{ "loanGUID": "[LOAN GUID]", "loanLOSID": "[LOS LOAN ID]", "notifyBorrowers": 0, "loanOfficerEmail": "loanofficer@besmartee.com" }

Below, you'll find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/import-loan" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $parameters );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

print_r( $response );

Response Format

The response will public loan ID, and return the root key error if not. See Error Codes and Handling.

{ "publicID": "UU473IOJ" }

POST /download-documents

The /download-documents endpoint will download a requested document. This endpoint also requires the following parameters:

JSON Payload Example

{ "docID": "[LOAN DOC PUBLIC ID]", "loanPublicID": "[LOAN PUBLIC ID]", "docTypes": [ "initial disclosures" ] }

Below, you will find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/download-documents" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, http_build_query($parameters) );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

echo $response;

Response Format

The response will output the document, and return the root key error if not.
See Error Codes and Handling.

Available Documents to Download

POST /upload-documents

The /upload-documents endpoint will upload a requested document. This endpoint also requires the following parameters:

JSON Payload Example

{ "loanPublicID": "[LOAN PUBLIC ID]", "documents": [ { "fileName": "Initial Disclosures", "fileFormat": "pdf", "fileContent": "[Base64EncodedString]", "documentType": "LoanDoc", "loanDocType": "initial disclosures" }, { "fileName": "W2", "fileFormat": "pdf", "fileContent": "[Base64EncodedString]", "documentType": "LoanConditionDocument", "conditionID": "[CONDITION PUBLIC ID]", "autoSatisfyCondition": true } ] }

Below, you will find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/upload-documents" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, http_build_query($parameters) );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

echo $response;

Response Format

The response will output the document, and return the root key error if not.
See Error Codes and Handling.

Available Documents to Upload

POST /download-condition-documents

The /download-condition-documents endpoint will download a requested condition document. This endpoint also requires the following parameters:

JSON Payload Example

{ "loanConditionPublicID": "[LOAN CONDITION PUBLIC ID]" }

Below, you will find details on all required parameters to be included in the JSON payload.

Example Request

$jsonPayload = {...};

$parameters = array(
     'format' => "json",
     'apiID' => YOUR_API_ID,
     'apiKey' => YOUR_API_KEY,
     'accessToken' => ACCESS_TOKEN,
     'data' => $jsonPayload
);

$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, "https://www.besmartee.com/api/lender/download-condition-documents" );
curl_setopt( $curl, CURLOPT_POST, count( $parameters ) );
curl_setopt( $curl, CURLOPT_POSTFIELDS, http_build_query($parameters) );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER, false );
$response = curl_exec( $curl );
curl_close( $curl );

echo $response;

Response Format

The response will output the document, and return the root key error if not.
See Error Codes and Handling.

The response will output the document or a zip file if multiple documents were requested, and return the root key error if not. See Error Codes and Handling.

Selecting Condition Documents to Download

Any request with multiple documents included will be packaged and returned as a .zip file.