Loan 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.

URI Format

All API calls must be made to:

https://www.besmartee.com/api/loan/{endpoint}

Required Parameters

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

POST /set-esign-url

The /set-esign-url endpoint will receive and store esign URLs, then email the borrower and coborrowers (if any) and loan officer (if specified) to let them know the initial disclosures are ready to sign.

This endpoint also requires the following parameters:

JSON Payload Example

{ "lenderID" : "ETKXMO6C", "loanID": "KZ8UXDKY", "docVendor": "Docutech", "loanOfficer": { "esignURL": "https://esignurl.com", "esignURLExpirationDate": "1483120275", "status": "ESignReady" }, "borrowers" : [ { "borrowerUID" : "12345", "esignURL" : "https://esignurl.com", "esignURLExpirationDate" : "1483120275", "status" : "ESignReady" }, { "borrowerUID" : "98765", "esignURL" : "https://esignurl.com", "esignURLExpirationDate" : "1483120275", "status" : "ESignReady" } ] }

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/loan/set-esign-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 docVendor is Docutech or IDS, response will return null (empty string) if successful.

If docVendor is DocMagic, response will return each borrower's redirectURL and loan officer's redirectURL (if specified) for DocMagic.

{ "loanID": "KZ8UXDKY", "borrowers": [ { "borrowerUID": "12345", "redirectURL": "https://url.com/redirect" }, { "borrowerUID": "98765", "redirectURL": "https://url.com/redirect" } ], "loanOfficer": { "loanOfficerUID": "56789", "redirectURL": "https://url.com/redirect" } }

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

POST /add-coborrowers

The /add-coborrowers endpoint will add coborrowers to an existing loan, then email the new coborrowers so they can start their application. If the coborrower already exists, their information will be updated, and if the email has changed then the coborrower will receive a new email to start their application.

Additionally, this endpoint may be used to delete an existing coborrower.

This endpoint also requires the following parameters:

JSON Payload Example

{ "lenderID" : "3WWPGZDC", "loanID": "LSLPFMRJ", "borrowers" : [ { "borrowerUID": "9973989", "firstName" : "Charles", "lastName" : "Cooper", "dob" : "10/22/1968", "phonePrimary" : "714-245-8223", "phoneSecondary" : "714-235-7114", "status" : "Married", "marriedToBorrowerUID" : "1234", "primaryAddressStreet1" : "16892 Bolsa Chica St", "primaryAddressStreet2" : "#201", "primaryAddressCity" : "Huntington Beach", "primaryAddressState" : "CA", "primaryAddressZipcode" : "92649", "email" : "charlescooper@mail.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/loan/add-coborrowers" );
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 (empty string) if successful. Response will return the root key error if any error. See Error Codes and Handling.

POST /get-loan-data

The /get-loan-data endpoint will return specified data per loan requested. This endpoint also requires the following parameters:

JSON Payload Example (search by loan identifier)

{ "loanID": "GZ3WWPDC", "classes" : [ "Loan", "LoanTerm", "LoanProperty", "Message", "MISMO34", "DataCredit", "DataCreditRawResponse", "LoanAUSFinding", "LoanAUSFindingRawResponse" ] }

JSON Payload Example (search by loan LOS identifier)

{ "lenderLoanNum": "1234567890", "classes" : [ "Loan", "LoanTerm", "LoanProperty", "Message", "MISMO34", "DataCredit", "DataCreditRawResponse", "LoanAUSFinding", "LoanAUSFindingRawResponse" ] }

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/loan/get-loan-data" );
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 array of Loan classes requested if successful. Response will return the root key error if any error. See Error Codes and Handling.

{ "Loan": { "publicID": "NINWCRRA", "losID": "TEST911900040788", ... }, "LoanTerm": { "mortAppliedFor": "Conventional", "agencyCaseNum": "TEST911900040788", ... }, "LoanProperty": { "isBorrower": 1, "subPropAddress1": "1234 Main Street", ... }, "Messages": [ { "id": "54715cd8dda91aa44e4942467fb2ebcd", "message": "Hi Andy. Thanks for signing up!...", ... }, { "id": "95e08407662b9f5679d75543f49173f0", "message": "Going on vacation this week...", ... }, ... ], "MISMO34": "<?xml version=\"1.0\"?> <MESSAGE ... ", "ResponseFull": { "adjustmentID": null, "apr": "4.776", "rate": "4.750", "pointsCreditsPercent": "1.578" ..., "antiSteeringOptions": { "lowestInterestRate": { "adjustmentID": null, "apr": "4.776", "rate": "3.125", "pointsCreditsPercent": "1.567", ... }, "lowestInterestRateWithoutRiskyFeatures": { "adjustmentID": null, "apr": "4.776", "rate": "3.125", "pointsCreditsPercent": "1.567", ... }, "lowestInterestRateWithoutRiskyFeatures": { "adjustmentID": null, "apr": "3.895", "rate": "3.875", "pointsCreditsPercent": "2.567", ... } } }, "DataCredit": { "CRAFannieProviderID": 3, "CRAName": "Factual Data by CBC", }, "LoanAssignment": { "internalUsers": [ { "type": "loanOfficer", "firstName": "John", "lastName": "Doe", "email": "testLO@bsmbank.com", "phone": "444-555-6633" } ], "externalUsers": [ { "type": "buyerAgent", "firstName": "Suzi", "lastName": "Test", "company": "DreamHome", "license": "1459242", "phone": "421-445-442", "email": "test@dreamhome.com" } ] } }

Below, you'll find more detail about response format

POST /get-loan-borrower-data

The /get-loan-borrower-data endpoint will return specified data per loan borrower requested. This endpoint also requires the following parameters:

JSON Payload Example

{ "loanID": "VOWKVHTZ", "borrowerUID" : "AED6AMZW", "classes" : [ "LoanBorrower", "LoanBorrowerEmployer", "LoanBorrowerPair" ] }

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/loan/get-loan-borrower-data" );
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 specified data per borrower requested. Response will return the root key error if any error. See Error Codes and Handling.

{ "LoanBorrower": [ { "isBorrower": 1, "isActive": 1, "firstName": "Alice", "middleName": null, "lastName": "Firstimer", "homePhone": "714-245-8223", "presentAddressStreet": "16892 Bolsa Chica St", "presentAddressCity": "Huntington Beach", "presentAddressState": "CA", "presentAddressZipcode": "92649", "presentAddress_status": "Rent", "presentAddress_years": "2.00", "mailingAddressSame": 0, "mailingAddressStreet1": "16892 Bolsa Chica St", "mailingAddressStreet2": "#201", "mailingAddressCity": "Huntington Beach", "mailingAddressState": "CA", "mailingAddressZipcode": "92649", "publicID": "AED6AMZW", ... } ], "LoanBorrowerEmployer": [ { "isActive": 1, "isCurrent": 1, "isPrimary": 1, ... } ] }

POST /create-lead

The /create-lead endpoint will create a lead (or update a lead or loan), which will then pre-populate the consumer and loan officer application experience. This endpoint also requires the following parameters:

JSON Payload Example

{ "losID" : "t5D7HgV3", "loanOfficerUID" : "11DfK59L", "borrowerUID" : "h0HyE55e", "leadURL" : "https://www.salesforce.com/lead", "salesforceOpportunityID" : "0061I00000Ev5dUQAR", "crmLeadID" : "1009103310", "firstName" : "Alice", "lastName" : "Firstimer", "dob" : "01/01/2017", "ssn" : "991919991", "status" : "Unmarried", "phonePrimary" : "7142357114", "email" : "borrower@besmartee.com", "primaryAddressStreet" : "16892 Bolsa Chica St #201", "primaryAddressCity" : "Huntington Beach", "primaryAddressState" : "CA", "primaryAddressZipcode" : "92649", "subjectPropertyAddressStreet" : "1234 Any Street", "subjectPropertyAddressCity" : "Anytown", "subjectPropertyAddressState" : "CA", "subjectPropertyAddressZipcode" : "55555", "homePrice" : 500000, "loanPurpose" : "Purchase", "cashOut": 10000, "propertyType" : "SingleFamily", "productType" : "MortgageLoan", "autoCheckTOUPP" : "0" "leadSource" : "Lending Tree", "referralPersonName" : "Joe Teller", "referralPersonID" : "8Q3nGlf3", "referralBranchName" : "Branch 12-1212", "referralBranchID" : "g9Dv5H74", "campaignPrimaryName" : "New Account Opening Special", "campaignPrimaryID" : "K3t4Bp5F", "offerPrimary" : "", "offerPrimaryPurpose" :"", "offerSecondary" : "", "offerSecondaryPurpose" : "", "segment" : "" }

Below, you'll find details on all parameters that can 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/loan/create-lead" );
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 unique publicID, if successful. If a lead is converted into a loan, the publicID will remain unchanged. Response will return the root key error, if any error. See Error Codes and Handling.

{ "publicID": "UU473IOJ" }

POST /add-conditions

The /add-conditions endpoint will add (or update) an array of conditions for a loan. This endpoint also requires the following parameters:

JSON Payload Example

{ "loanID": "VOWKVHTZ", "conditions" : [ { "losUID" : "3K12FDT3", "viewableByBorrower" : "1", "dateDue" : "1483120275", "type" : "PTD", "category" : "Income", "docType" : "Income", "description" : "Provide copy of last two month W-2s.", "status" : "New" }, { "losUID" : "R8FDK17B", "loanConditionUID" : "PLY22UVG", "loanBorrowerUID" : "15FGKDRY", "viewableByBorrower" : "1", "type" : "PTD", "category" : "Application", "docType" : "Misc", "description" : "Provide letter explaining gap in employment.", "status" : "Satisfied" } ] }

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/loan/add-conditions" );
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 array of condition UIDs for all conditions requested. Response will return the root key error if any error. See Error Codes and Handling.

{ "conditions": [ { "losUID": "3K12FDT3", "loanConditionUID": "D6U1Y2V1" }, { "losUID": "R8FDK17B", "loanConditionUID": "PLY22UVG" } ] }

POST /update-loan-data

The /update-loan-data endpoint will sync loan data from LOS to BSM. This endpoint also requires the following parameters:

JSON Payload Example

{ "posLoanUID": "RC1YBIV5", "losLoanOfficerUID": "loan_officer@lender.com", "losLoanData": [ { "dataFormat": "fnma", "data": "[REQUIRED_FNMA_32_HERE]" }, { "dataFormat": "mismo33", "data": "[OPTIONAL_XML_HERE]" }, { "dataFormat": "mismo34", "data": "[REQUIRED_XML_HERE]" } ], "losMiscLoanData": { "loanStatusMain": "Start Application", "loanStatusSub": "Sign Up", "programID": "123456", "losLoanUID": "123456789" } }

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/loan/update-loan-data" );
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 /update-loan-fee

The /update-loan-fee endpoint will return list fees in loan. This endpoint also requires the following parameters:

JSON Payload Example

{ "posLoanUID": "RC1YBIV5", "fees": [ { "action": "Update", "feeID": 1663896, "amountPaidByBorrower": 600 }, { "action": "Update", "feeID": 1663894, "MISMOType": "HomeownersInsurancePrepaid", "monthsCollected": 4, "monthlyAmount": 63.73 }, { "action": "Update", "feeID": 1663894, "MISMOType": "Other", "MISMOTypeOtherDescription": "Title - Examination", "name": "Title - Examination", "amountPaidByBorrower": 290 } ] }

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/loan/update-loan-fee" );
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.