True Owner Documentation
    • Dark
      Light
    • PDF

    True Owner Documentation

    • Dark
      Light
    • PDF

    Article summary

    Purpose

    The purpose of this API is to uncover contact information so that one can get to the decision-makers with ease. True Owner information can be elusive, especially at the national level. LightBox has curated one of the largest sets of commercial property contact information available.  Once a property is identified the next question is how do I get in contact with the owner. This is where the True Owner API comes in. 

    Swagger: OAS 3.1 Specification

    Features

    • Query property contacts using an address to return all property contacts on matched address results.
    • Pass in a LightBox assessment ID to return allproperty contacts related to that assessment record.
    • Pass in a LightBox parcel ID to return allproperty contacts of an assessment record tied to that parcel.
    • Pass in a LightBox structure ID to return all matched property contacts on that structure.
    • Pass in a LightBox address ID to return all matched property contacts related to that address.
    • Pass in a Lightbox Contact ID to return all assessments with the passed property contact.
    Pro Tip
    While any LightBox ID will return contact information, the best ID to use is the Assessment ID. True Owner contacts are related to the assessment record and that is why the Assessment ID is preferred. 
    Pro Tip
    Want to understand what properties a single contact is related to? Use the LightBox contact id (person_id) or contact.id within the response, on the Assessment API endpoint _on/person. This endpoint will use the contact id (person_id) and identify all assessment records this contact/person is related to.  



    Requirements

    The LightBox APIs are hosted in the cloud and therefore have no platform requirements. Application requirements include:

    • A network connection to the LightBox API server

    • Ability to parse JavaScript Object Notation (JSON) API responses

    • Secure HTTPS connection

    • LightBox authentication key

    Connecting your account

    When your LightBox user account is created, a unique API key is also generated. The API key should be kept secret at all times and can only be used for API requests. The key is required in all API calls.

    To retrieve your unique API key:

    • Log in to the LightBox Developer Portal 
    • Select Apps from the menu bar
    • In your approved App, note your API key (under Consumer Key)

    Performing API requests

    All API requests must be made over secure HTTPS connections. Requests made over HTTP will fail.

    The base URL of the API server that all API requests will be made to is: https://api.lightboxre.com/ followed by a version number https://api.lightboxre.com/v1

    Authentication

    LightBox APIs uses a token-based authentication. All requests to the LightBox APIs must be authenticated. The token to be passed via an HTTP header with key 'x-api-key' and value <Your authentication token>

    Pass your unique API key in the authorization header of every LightBox API call.  LightBox uses this information to authenticate your identify and determine whether you have sufficient permissions to complete the operation. curl -X GET -H ‘x-api-key: (api_key)’  https://api.lightboxre.com/

    API Requests

    Get Property Contacts by Address

    Return property contact records that are related to an address.

    GET /property-contacts/address?text={text}

    Example Requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/property-contacts/address?text=5201 California Ave, Irvine CA

    https://api.lightboxre.com/v1/property-contacts/address?text=5201 California Ave, Irvine CA

    ParameterTypeDescriptionUsage
    textqueryFull or partial address string for matching.
    required

    Response

    Media type: application/json

    Get Property Contacts by Business Entity

    Return property contact records that are related to a business entity.

    GET /property-contacts/business-entities?name={name}&matchType={matchType}

    Example Requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.stage.corp.lightboxre.com/v1/property-contacts/business-entities?name=VICALE%20LLC&matchType=exact

    https://api.stage.corp.lightboxre.com/v1/property-contacts/business-entities?name=VICALE%20LLC&matchType=exact

    ParameterTypeDescriptionUsage
    namequeryFull or partial business entity string for matching.
    required
    matchTypequeryA string specifying under what criterion to search for the business entity - may be "exact" or "startsWith".required

    Response

    Media type: application/json

    Get Property Contacts by Contact ID

    Return all property contact records associated with a particular contact.

    GET /property-contacts/contact/{id}

    Example Requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.stage.corp.lightboxre.com/v1/property-contacts/contact/1201ML27JKRDUBSZTJDMU2

    https://api.stage.corp.lightboxre.com/v1/property-contacts/contact/1201ML27JKRDUBSZTJDMU2

    ParameterTypeDescriptionUsage
    idpathThe Contact ID.required

    Response

    Media type: application/json

    Get Property Contacts by Address ID

    Return property contact records that are related to an address identified by the LightBox Address ID.

    GET /property-contacts/_on/address/us/{id}

    Example Requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/property-contacts/_on/address/us/0604YLLT99JMIUM595E4XT

    https://api.lightboxre.com/v1/property-contacts/_on/address/us/0604YLLT99JMIUM595E4XT

    ParameterTypeDescriptionUsage
    idpathThe LightBox Address ID.required

    Response

    Media type: application/json

    Get Property Contacts by Parcel ID

    Return property contact records that are on a parcel using the LightBox Parcel ID.

    GET /property-contacts/_on/parcel/us/{id}

    Example requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/property-contacts/_on/parcel/us/02034UK8D0FPUGRCMY8L76

    https://api.lightboxre.com/v1/property-contacts/_on/parcel/us/02034UK8D0FPUGRCMY8L76

    ParameterTypeDescriptionUsage
    idpathThe LightBox Parcel ID.required

    Response

    Media type: application/json

    Get Property Contacts by Structure ID

    Return property contact records that are on a structure using the LightBox Structure ID.

    GET /property-contacts/_on/structure/us/{id}

    Example requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/property-contacts/_on/structure/us/050172LL8ZS2SXELX0FRE0

    https://api.lightboxre.com/v1/property-contacts/_on/structure/us/050172LL8ZS2SXELX0FRE0

    ParameterTypeDescriptionUsage
    idpathThe LightBox Structure ID.required

    Response

    Media type: application/json

    Get Property Contacts by Assessment ID

    Return property contact records that are related to an assessment using the LightBox Assessment ID.

    GET /property-contacts/_on/assessment/us/{id}

    Example requests

    curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/property-contacts/_on/assessment/us/03029JH5KG17JF5Y10YBHT

    https://api.lightboxre.com/v1/property-contacts/_on/assessment/us/03029JH5KG17JF5Y10YBHT

    ParameterTypeDescriptionUsage
    idpathThe LightBox Structure ID.required

    Response

    Media type: application/json

    API Response

    For each endpoint other than the tile requests, the response will stay consistent. 

    {
      "_links": {
        "self": {
          "href": "https://api.lightboxre.com/v1/property-contacts/contact/120376FAJ8XHRJBVGCALN8"
        }
      },
      "_metadata": {
        "geogcs": {
          "epsg": "4362"
        },
        "recordSet": {
          "totalRecords": 1,
          "bbox": {
            "xMax": -105.250409,
            "xMin": -105.251916,
            "yMax": 40.023629,
            "yMin": 40.022576
          }
        },
        "geocode": {
          "confidence": {
            "streetNumber": 0.98,
            "streetName": 1,
            "locality": 0.99,
            "postalCode": 1,
            "score": 0.99
          },
          "precisionCode": 10
        }
      },
      "data": [
        {
          "_ids": {
            "self": null,
            "assessment": "03019ZZRP1MR0TST3RQC36",
            "parcel": "0205PZNY99O607GJU9JRFT"
           },
          "_links": {
            "self": {
              "href": "https://api.lightboxre.com/v1/property-contacts/contact/120376FAJ8XHRJBVGCALN8"
            },
            "assessment": {
              "href": "https://api.lightboxre.com/v1/assessments/us/03019ZZRP1MR0TST3RQC36"
            },
            "parcel": {
              "href": "https://api.lightboxre.com/v1/parcels/us/0205PZNY99O607GJU9JRFT"
            }
          },
          "assessment": {
            "location": {
              "streetAddress": "23143 CHERRY AVE",
              "locality": "LAKE FOREST",
              "regionCode": "CA",
              "postalCode": "92630",
              "postalCodeExt": "4537",
              "countryCode": "US",
              "representativePoint": {
                "longitude": -117.687713,
                "latitude": 33.627483,
                "geometry": {
                  "wkt": "POINT(-117.687713 33.627483)"
                }
              },
              "geometry": {
                "wkt": "POINT(-117.687713 33.627483)"
              }
            }
          },
          "source": "LIGHTBOX",
          "contacts": [
            {
              "id": "120376FAJ8XHRJBVGCALN8",
              "confidence": 1,
              "titles": [
                "REGISTERED AGENT"
              ],
              "firstName": "RICHARD",
              "middleName": "F",
              "lastName": "CODY",
              "nameSuffix": "JR",
              "deceased": false,
              "address": {
                "streetAddress": "23143 CHERRY AVE",
                "locality": "LAKE FOREST",
                "regionCode": "CA",
                "postalCode": "92630",
                "postalCodeExt": "4537",
                "countryCode": "US"
              },
              "emails": [
                "john-doe@yahoo.com"
              ],
              "phones": [
                {
                  "number": "4258618500",
                  "type": "L",
                  "firstSeen": "2023-02-15T00:00:00.000Z",
                  "lastSeen": "2023-02-15T00:00:00.000Z"
                }
              ],
              "businessEntity": {
                "name": "OROMO CULTURAL CENTER",
                "emails": [
                  "john-doe@yahoo.com"
                ],
                "address": {
                  "streetAddress": "23143 CHERRY AVE",
                  "locality": "LAKE FOREST",
                  "regionCode": "CA",
                  "postalCode": "92630",
                  "postalCodeExt": "4537",
                  "countryCode": "US"
                },
                "phone": {
                  "number": "4258618500",
                  "type": "L",
                  "firstSeen": "2023-02-15T00:00:00.000Z",
                  "lastSeen": "2023-02-15T00:00:00.000Z"
                },
                "corporateStatus": [
                  "ACTIVE"
                ]
              },
              "relatedBusinessEntity": "string"
            }
          ]
        }
      ]
    }

    Field Dictionary

    FieldTypeDescription
    _linksobjectLinks pertaining to the response.
    _links.selfobjectItems pertaining to the response.
    _links.self.hrefstringReference API callback to this property contact object.
    assessmentobjectInformation about the relevant assessment.
    assessment.location.streetAddress
    stringStreet address, which comprises street name, street directional prefix, street number, street suffix, unit type, and unit number (e.g., '125 Main Street S Unit 5').
    assessment.location.locality
    string
    The city portion of the assessment (e.g., CHICAGO, ATLANTA, DENVER, etc.).
    assessment.location.regionCodestring
    Region code based on country code, including USPS Pub. 28 App. B for the United States and ISO 3166-2:CA for Canada.
    assessment.location.postalCodestring
    5-digit postal code.
    assessment.location.postalCodeExtstring
    4-digit postal code extension.
    assessment.location.countryCodestring
    ISO 3166 alpha-2 country code (e.g., 'US' for the United States).
    assessment.location.representativePointobjectInformation about the representative point of the assessment.
    assessment.location.representativePoint.longitudedoubleA geographic coordinate that specifies the east-west position of a point on the Earth's surface, or the surface of a celestial body.
    assessment.location.representativePoint.latitudedoubleA geographic coordinate that specifies the north-south position of a point on the Earth's surface, or the surface of a celestial body.
    assessment.location.representativePoint.geometryobjectThe geometry of the assessment location.
    assessment.location.representativePoint.geometry.wktstringWell-Known Text representation of the point.
    sourcestringThe source of this information - "LIGHTBOX" if particular property contact information is found, "ASSESSMENT" if particular information cannot be found and we must defer to assessment information.
    contactsarrayList of Property Contact objects.
    contacts.idstringLightBox Person ID.
    contacts.confidencedouble

    contacts.titlesarray
    contacts.firstNamestring
    The first name of the property contact.
    contacts.middleNamestring
    The middle name of the property contact.
    contacts.lastNamestringThe last name of the property contact.
    contacts.nameSuffixstringThe name suffix of the property contact.
    contacts.addressstringInformation about the property contact's address.
    contacts.address.streetAddressstringThe street address of the property contact.
    contacts.address.locality
    stringThe city portion of the property contact's address (e.g., CHICAGO, ATLANTA, DENVER, etc.).
    contacts.address.regionCode
    stringRegion code based on country code, including USPS Pub. 28 App. B for the United States and ISO 3166-2:CA for Canada.
    contacts.address.postalCode
    string5-digit postal code.
    contacts.address.postalCodeExt
    string4-digit postal code extension.
    contacts.address.countryCode
    stringISO 3166 alpha-2 country code (e.g., 'US' for the United States).
    contacts.emails
    arrayList of the property contact's email addresses.
    contacts.phonesarrayList of the property contact's Phone objects.
    contacts.phones.number
    stringThe property contact's phone number.
    contacts.phones.type
    stringThe property contact's phone type. This can either be "L" for a landline, or "C" for a cell phone.
    contacts.phones.firstSeen
    stringISO 8601 time of when this phone number was first seen.
    contacts.phones.lastSeen
    stringISO 8601 time of when this phone number was last seen.
    contacts.businessEntityobjectInformation about the property contact's corporation.
    contacts.businessEntity.name
    stringThe name of the relevant corporation.
    contacts.businessEntity.emails
    arrayList of the property contact's corporation's email addresses.
    contacts.businessEntity.address
    objectInformation about the property contact'scorporation's address.
    contacts.businessEntity.address.streetAddress
    stringStreet address, which comprises street name, street directional prefix, street number, street suffix, unit type, and unit number (e.g., '125 Main Street S Unit 5').
    contacts.businessEntity.address.locality
    stringThe city portion of the corporate address (e.g., CHICAGO, ATLANTA, DENVER, etc.).
    contacts.businessEntity.address.regionCodestringRegion code based on country code, including USPS Pub. 28 App. B for the United States and ISO 3166-2:CA for Canada.
    contacts.businessEntity.address.postalCodestring5-digit postal code.
    contacts.businessEntity.address.postalCodeExtstring4-digit postal code extension.
    contacts.businessEntity.address.countryCode
    stringISO 3166 alpha-2 country code (e.g., 'US' for the United States).
    contacts.businessEntity.phoneobjectInformation about the property contact's corporation's phone.
    contacts.businessEntity.phone.numberstringThe property contact's corporate phone number.
    contacts.businessEntity.phone.typestringThe property contact's corporate phone type. This can either be "L" for a landline, or "C" for a cell phone.
    contacts.businessEntity.phone.firstSeen
    stringISO 8601 time of when this phone number was first seen.
    contacts.businessEntity.phone.lastSeen
    stringISO 8601 time of when this phone number was last seen.
    contacts.businessEntity.corporateStatus
    array
    contacts.relatedBusinessEntitystringThe corporation the contact may be related to.

    HTTP Error Codes

    HTTP Response status codes along with a brief summary of their commonly accepted usage. These status codes are returned by LightBox APIs for each request:
    200
    The request succeeded.
    201
    The object was created successfully
    202Accepted, no content
    204Successful, no content
    204
    The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. Typically returned on a DELETE
    400
    One or more of the request parameters were invalid.
    401
    The client must authenticate itself to get the requested response. Note: This could also be due to your trial key has expired.
    404
    The server cannot find the requested resource. This can also mean that the endpoint is valid but the resource itself does not exist.
    429
    Too many requests were made in a short period of time, or you have exceeded your request-lot pool.
    500
    The server has encountered an error it does not know how to handle.
    503Service Unavailable.





    Was this article helpful?