API – Addresses

General

Many entities will require address information. Often, to set the address for an entity in LoanPro, you will send the address information in the address field of the entity.

 To update a customer’s address, you will need to send a PUT request to the url of the desired customer. For example, to update a customers address with the customer id of 1137, the url would be  https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers(1137)

Below is a sample payload for setting the primary address of a customer:

{
"PrimaryAddress": {
"address1": "53 321 Street",
"address2": null,
"city": "HENEFER",
"state": "geo.state.NJ",
"zipcode": "840331342",
"country": "company.country.usa",
"geoLat": "41.017894",
"geoLon": "-111.4879125",
"active": 1,
"isVerified": 0,
"isStandardized": 0
}
}
  • address1 – The street address
  • address2 – Any additional street address information (e.g. suite number, apartment number)
  • city – The city
  • state – The state
    • States are formatted “geo.state.<State Code>” where <State Code> is the two character abbreviation of the state
    • For Canada, it is formatted “geo.state.<Province Code>” where <Province Code> is the two character abbreviation of the province
  • zipcode – The ZIP code where the address is located
  • geoLat – The latitude of the address (optional)
  • geoLon – The longitude of the address (optional)
  • active – Set to “1” to be able to use the address
  • isVerified – Whether or not the address has been verified (usually through USPS)
  • isStandardized – Whether or not the address has been standardized through USPS

Linking Addresses to Customers

To link an address to a customer, include the address in the “PrimaryAddress” or “MailAddress” properties of the customer (see above for how these should look). The PrimaryAddress field will change the customer’s primary address, while the MailAddress field will change the mailing address.


How did we do?


Powered by HelpDocs (opens in a new tab)