Get started

    API Endpoint

         "<datazapp api endpoint URL>"

The Home Owner Flag Append API determines whether an individual is a homeowner or renter by cross-referencing information such as name and address, name and phone number, or name and email address.

To use this API, you need an API key. Please contact us at [email protected] to get your API key.

Home Owner Flag Append API Request

Query Parameters

Request                    
{
   "ApiKey": "Put your api key here",
   "AppendModule": "HomeOwner", 
    "Data": [
        {

              "Address": "7x Oxx Rxx Txx xD",
              "City": "Pexxn",
              "FirstName": "Suxxn",
              "LastName": "Kxxs",
              "Zip": "0xxx1",
              "email":"[email protected]",
              "Phone":"8xxxxxxxx0"
        }
   ]
}

Parameter	Type	Required	Description
APIKey	String	Required	Issued by Datazapp Support.
AppendModule	String	Required	Value should be “HomeOwner.”
Data Object (Array): An array containing the following parameters for each record.
Address	String	Required	Valid United States postal address.
City	String	Required	City name.
FirstName	String	Required	First name of the person.
LastName	String	Required	Last name of the person.
Zip	String	Required	5-digit Zip code associated. Zip or Zip+4 is accepted.
Email	String	Optional	An individual’s email address can be from any domain (e.g., [email protected]).
Phone	String	Optional	Contact number of an individual

Response

Query Parameters

                    

Response

{
    "header": {
        "Status": 0,
        "Message": null
    },
    "ResponseDetail": {
        "App": 0,
        "Token": "xxxxxx",
        "Data": [
            {
                "Matched": true,
                "OwnOrRent": "Own",
                "Email": "[email protected]",
                "Phone": "8xxxxxxxx0",
                "Tag": "",
                "FirstName": "Suxxn",
                "LastName": "Kxxs",
                "Address": "7x Oxx Rxx Txx xD",
                "City": "Pexxn",
                "Zip": "0xxx1"
            }
        ],
        "OrderAmount": "$0.002",
        "Count": 1,
        "Message": null,
        "ProcessedTime": "In milliseconds"
    },
    "Status": true,
    "Message": null
}

Field	Type	Description
Following Parameters returned in Header:
Status	Integer	Indicate header status
Message	String	Indicate type of error
Following Parameters returned in ResponseDetails:
Token	String	System generated reference.
Below Parameters will be returned as Data Object in Array Format:
Matched	String	True=if matched, False=if not matched data
OwnOrRent	String	It will return the type of home ownership, such as Owner (Own), Renter (Rent).
Email	String	Email (Email of person)
FirstName	String	First name (name of person in household)
LastName	String	Last name (name of person in household)
Address	String	Street Address.
City	String	City name.
Zip	String	Zip code associated. Zip or Zip+4 is accepted.
OrderAmount	String	Amount of count
Count	String	Number of count
ProcessedTime	String	Processing time
Status	String	True
Message	String	Error Message in case of any error.

Errors

The API uses the following error codes:

Error Code	Meaning
Module does not exist.	The specified module does not exist or Invalid AppendModule Name.
User not found.	Invalid API Key or The user associated with the API key was not found
Getting 401 Error.	The user does not have access to this API
Append Request not found	Invalid Token: The specified append request could not be found
Improper JSON Data. Please check.	The JSON data in the request does not match the expected format.
It seems like API has an issue. Please contact Support.	There is an issue with the API. Contact the [email protected]