CINC API

Address

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}/homeowner/address

Parameter Descriptions

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

  • assocCode (Association Code): Ability to filter data by association

  • address: Ability to filter data by address

Paramter Types

  • mgmtId: string (required)

  • assocCode: string (required)

  • address: string (required)

Response Body

The response object:

{
    "HoaId": string,
    "associationIDLink": string,
    "FirstName": string,
    "LastName": string,
    "Status": string,
    "HomePhone": string,
    "WorkPhone": string,
    "MobilePhone": string,
    "HomeAddress1": string,
    "HomeAddress2": string,
    "HomeCity": string,
    "HomeState": string,
    "HomeZip": string,
    "HomeEmail": string,
    "MailingAddress1": string,
    "MailingAddress2": string,
    "MailingCity": string,
    "MailingZip": string,
    "MailingEmail": string,
    "UnitNo": string,
    "LotNo": string,
    "CollectionStatus": string,
    "FirstName2": string,
    "LastName2": string,
    "WebUser": string,
    "BoardMember": string,
    "CreatedDate": datetime,
    "UpdatedDate": datetime,
    "Balance": decimal
  },

The following shows example data being returned

[
{
    "HoaId": "34355",
    "associationIDLink": "00000",
    "FirstName": "QA",
    "LastName": "QA",
    "Status": "3 Day Collections Letter",
    "HomePhone": "",
    "WorkPhone": "",
    "MobilePhone": "",
    "HomeAddress1": "QA",
    "HomeAddress2": "",
    "HomeCity": "",
    "HomeState": "AK",
    "HomeZip": "",
    "HomeEmail": "##",
    "MailingAddress1": "QA",
    "MailingAddress2": "",
    "MailingCity": "",
    "MailingZip": "",
    "MailingEmail": "##",
    "UnitNo": "",
    "LotNo": "",
    "CollectionStatus": "",
    "FirstName2": "QA",
    "LastName2": "",
    "WebUser": "False",
    "BoardMember": "False",
    "CreatedDate": "2014-04-08T18:01:05.1",
    "UpdatedDate": "2018-05-30T05:36:38.11",
    "Balance": 0
  }
]

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 does not have permission to perform the request.

404 - Not Found: The requested resource does not exist.