Welcome to BeSmartee!
BeSmartee is reinventing how consumers get a home loan. We imagine a new mortgage process that's easy, fast and transparent. A consumer can easily apply to multiple lenders, receive real-time approvals from all of them and choose a loan to close entirely online.
To this end, we've created the BeSmartee API so that we can bring together the best providers our industry has to offer with one goal in mind: to deliver an exceptional customer experience.
The BeSmartee API is architected around REST and will accept either POST or GET requests as indicated for each endpoint. All responses can be returned either as JSON or XML. Both data formats are fully functional with all endpoints.
Access to the BeSmartee API is authorized only for approved vendor partners who are referred by a lender participating on the BeSmartee platform. If you service one of these lenders and wish to integrate, please contact us.
API errors occur for several reasons. Here's a list of common errors and ways to troubleshoot them:
| Error Code | Description | Troubleshooting |
|---|---|---|
| 400 | Bad Request | Server cannot or will not process request due to something that is perceived as a client error. Check URL and parameters. |
| 401 | Unauthorized | Similar to 403 Forbidden, but specifically for when authentication is required and has failed or has not yet been provided. Check API credentials. |
| 403 | Forbidden | The request was valid, but the server is refusing to respond to it. You are not authorized to access this resource. |
| 501 | Not Implemented | Server either does not recognize the request method, or it lacks the ability to fulfill the request. |
| 502 | Bad Gateway | Server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in the attempt to fulfill the request. |
| 503 | Service Unavailable | Server is currently unavailable, because it is overloaded or down for maintenance.Generally, this is a temporary state. |
| 504 | Gateway Timeout | Server was acting as a gateway or proxy and did not receive a timely request from the upstream server. |
You should always check for the root key error. When an error occurs, you should get the following response:
{
"error":
{
"code":xxx,
"message":"Some message."
}
}
If an error persists that you cannot resolve, please contact us for assistance.
