CINC API

HomeOwnerInfo

Go Back

Get detailed homeowner information.

Currently allowing the following protocols:

  • GET ONLY

Request URL

GET End Point

https://yourcustomerdatabase.cincsys.com/api/management/{mgmtId}/homeowners/homeownerlookup

Parameter Descriptions

  • mgmtId (Management Id): Pass your management ID.

  • email (Home Owner Email): Find the homeowner by their email address.

  • phone (home Owner Phone Number): Find the homeowner by their phone number.

Parameter Types

  • mgmtId: string (required)

  • assocCode: string (optional)

  • createdDate: datetime (optional)

  • updateDate: datetime (optional)

Response Body

The response object:

{
    "numPropertyID": int,
    "Name": string,
    "txtPropertyName": string,
    "txtPropertyLName": string,
    "txtPropertyName2": string,
    "txtAddress": string,
    "numStreetNo": int,
    "txtPropertyAddress1": string,
    "txtPropertyAddress2": string,
    "txtAcctUnitLot": string,
    "txtPropertyHOID": string,
    "txtLotNo": string,
    "txtUnitNo": string,
    "txtPropertyCity": string,
    "txtPropertyState": string,
    "ZipPropertyZip": string,
    "EmlPropertyEmail": string,
    "txtBillingTypeDescr": string,
    "txtPropertyStatusDescr": string,
    "Phone": string,
    "numBalance": decimal,
    "txtAddrTypeDescr": string
  },

The following shows example data being returned

[
{
    "numPropertyID": 9577,
    "Name": "Matthew Patrick McAvoy  ",
    "txtPropertyName": "Matthew Patrick McAvoy",
    "txtPropertyLName": "McAvoy",
    "txtPropertyName2": " ",
    "txtAddress": "423-75 West Eighth Street  75 ",
    "numStreetNo": 0,
    "txtPropertyAddress1": "423-75 West Eighth Street",
    "txtPropertyAddress2": "",
    "txtAcctUnitLot": "75",
    "txtPropertyHOID": "WE75",
    "txtLotNo": "",
    "txtUnitNo": "75",
    "txtPropertyCity": "Charlotte",
    "txtPropertyState": "NC",
    "ZipPropertyZip": "28202",
    "EmlPropertyEmail": "##mcavoy99@hotmail.com",
    "txtBillingTypeDescr": "Statements",
    "txtPropertyStatusDescr": "Occupied",
    "Phone": "",
    "numBalance": -0.92,
    "txtAddrTypeDescr": "Property Address"
  }
]

Response Codes

200 - OK: Everything worked as expected.

400 - Bad Request: The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized: No valid API key provided.

402 - Request Failed: The parameters were valid but the request failed.

403 - Forbidden: The API key doesn't have permission to perform the request.

404 - Not Found: The requested resource doesn't exist.