Intuitive. Powerful. "Maximum Profitability" ®
     Home   Products   Pricing   Order   Support   About Us   Contact Us   

Need Help?
call 877-886-8832

 

 

Starting at $198
Order here..

 

 

 

 

 

 

 

Integrated XML Tenant Screening (IXTS) Provider Interface

IXTS Introduction
Making Software Available FREE to your Customers
Provider Exclusivity Option
Co-Branding Opportunity
IXTS Advantages: Customer Loyalty, Retention, & Acquisition
Tenant Screening Provider Server Specification
Server Response XML Dataset
Server Implementation Sample (Active Server Pages on IIS)
IXTS Interface Commands
REP_REQUEST Command
CHANGE_PWD Command
UPDATE_CC Command
IXTS Response Codes & Error Messages

 

 
IXTS Introduction

The Integrated XML Tenant Screening Interface allows a Tenant Screening Provider's services to be integrated directly into the PropertyThree Software. This allows your customers to access your services and request credit reports directly from within the software without having to re-enter all their tenant data. The interface provide three command that allow the Provider to control how they wish to handle the Tenant Screening requests from the PropertyThree user. The communication is between the landlord or property owner and the Tenant Screening Provider directly.

To participate a provider is required to register with PropertyThree Inc. to make their services available to users of PropertyThree Management Software. They do this by implementing the Provider Server Specification. Once tested and approved PropertyThree Inc will add the Provider's Server URL and other related data to the list of available Tenant Screening Providers. The Server URL is required to be running in a Secure Sockets Layer (SSL) 128-bit environment for maximum security.

Co-Branding Opportunity

As you provide PropertyThree to your own customers you might want to co-brand the software to help solidify your Brand. For instance if your company name is "XYZ Tenant Screening" when your customers install and run PropertyThree, it will be titled "Property3 Software by XYZ Tenant Screening". This has always been known to work well in enhancing brand awareness within your client base. If anything they will always remember they got the software through your company. This option is available for a small annual premium.

Making Software Available FREE to your Customers

PropertyThree is currently accepting co-marketing arrangements where a provider can be provided free licenses for existing as well as new tenant screening customers for the PropertyThree Lite Edition software. With a solid co-marketing agreement this option can be available without paying any fees. Please contact us for more details.

Provider Exclusivity Option

In addition to Co-Branding PropertyThree also adds another dimension to branding and customer retention, you can make your company the exclusive Tenant Screening Provider for the licenses that you distribute. This option is available for a small annual premium.

IXTS Advantages: Customer Loyalty, Retention, & Acquisition

All in all IXTS allows you to attract more new customers by offering what most Tenant Screening companies cannot offer; FREE Property Management Software with integrated tenant screening. This could turnout to be the deciding factor for landlords and property owners.

With the exclusive option and co-branding opportunities you can now be assured your customers will stay with you for the long haul. As long as they continue to use PropertyThree they will find your service convenient and readily available. To use another service they would have to re-type all their tenant data again.

Of course having the software titled "Property3 Software by XYZ Tenant Screening" will make the customer remember your brand daily or as many times as they use the software.

 

Tenant Screening Provider Server Specification

The Tenant Screening Provider is required to register with PropertyThree Inc. in order to be a provider within the PropertyThree software. An arrangement can be reached to provide the Lite Edition of PropertyThree for free to provider's registered customers.

The Server Specification uses a standard HTML POST as the request and returns a specifically formatted XML Dataset back to the client with the following structure:

Server Response XML Dataset

The Server Response XML Dataset contains the following fields:

Field Name
Data Type
Comment
return_code
integer
Return codes as specified in the Returns Codes Index. With Code 1000 representing a successful request and everything else an exception condition.
return_message
string
Returns the text description of the return_code or specific instructions on how to redress an exception. Typically contains 'Success' on return_code 1000.
credit_report_data
string
Contains the XML encoded HTML that is the resultant Credit Report. This then gets extracted from the XML into a standard HTML file for landlord viewing and storage.
credit_report_url
string
An optional way to supply the credit report instead of sending it inline with the result. PropertyThree turns around and queries this URL for the HTML credit report if the return_code is 1000.

 

Server Implementation Sample (Active Server Pages on IIS)

PropertyThree provides a 95% ready to run sample Server implementation of the IXTS interface. You would have to plugin your system specific authentication and credit report request logic. Please contact us more this sample.

IXTS Interface Commands

Every IXTS request is required to supply a REQ_CMD, AccountUserID, and AccountPassword parameters. The REQ_CMD parameter has to specify one of the following commands:

Command
Description
REP_REQUEST Used to request a new Credit Report for a tenant
CHANGE_PWD Used to change the landlord's Account password at the Provider
UPDATE_CC Used to update expired or invalid Credit Card data at the Provider

REP_REQUEST Command

The is the command issued to request a credit report. For this reason it requires the landlord's account login credentials as well as the ReportType to request. The remainder of the fields are to do with the tenant whose credit is being requested. The command parameters are as follows:

Parameter
Data Type
Required
Description
AccountUserID
string
Yes
The landlord or Property Owners' account User ID at the Screening Provider
AccountPassword
string
Yes
The landlord or Property Owners' account Password at the Screening Provider
ReportType
string
Yes
The ID of the Report Type requested for instance Experian w/Score, Eviction, TransUnion with Score, etc. Report types are registered with PropertyThree Inc for each Screening Provider. Contact PropertyThree Inc to add more types.
FirstName
string
Yes
Tenant's First Name
MI
string
Tenant's Middle Initial
LastName
string
Yes
Tenant's Last Name
SSN
numeric
Yes
Tenant's 9 digit Social Security Number, no dashes just the numbers
DOB
string
Yes
Tenant's Date of Birth
CurrentAddress
string
Yes
Tenant's Current Address
CurrentAptNumber
string
Yes
Tenant's Current Apt Number if available
CurrentCity
string
Yes
Tenant's Current City
CurrentState
string
Yes
Tenant's Current State
CurrentZip
numeric
Yes
Tenant's Current Zip
CurrentYears
string
Tenant's Years at Current Address
CurrentMons
string
Tenant's Months at Current Address
PrevAddress
string
Tenant's Previous Address
PrevAptNumber
string
Tenant's Previous Apt Number if available
PrevCity
string
Tenant's Previous City
PrevState
string
Tenant's Previous State
PrevZip
numeric
Tenant's Previous Zip
PrevYears
string
Tenant's Previous Number of Years at Address
PrevMons
string
Tenant's Previous Number of Months at Address
CurrentJobYears
string
Tenant's Years at Current Job
CurrentJobMons
string
Tenant's Months at Current Job
CurrentJobIncome
string
Tenant's Income at Current Job
CurrentIncomeFrequency
string
Tenant's Employer at Current Job
ContinuousEmpYears
string
Tenant's Years of Continuous Employment
ContinuousEmpMons
string
Tenant's Months of Continuous Employment

 

CHANGE_PWD Command

This command is used to change the landlord or Property Owner's Tenant Screening Account Password at the Screening Provider and has the following parameters:

Parameter
Data Type
Required
Description
AccountUserID
string
Yes
The landlord or Property Owners' account User ID at the Screening Provider
AccountPassword
string
Yes
The landlord or Property Owners' account Password at the Screening Provider
NewPassword
string
Yes
The new landlord or Property Owners' account Password at the Screening Provider
       

 

UPDATE_CC Command

This command is used to update outdated or invalid credit card data at the Tenant Screening Provider and has the following parameters:

Parameter
Data Type
Required
Description
AccountUserID
string
Yes
The landlord or Property Owners' account User ID at the Screening Provider
AccountPassword
string
Yes
The landlord or Property Owners' account Password at the Screening Provider
CardNumber
numeric
Yes
The new credit card number
CardholderName
string
Yes
Card Holder Full Name
ExpirationDate
string
Yes
Card Expiration Date
CCVCode
numeric
Yes
Card's security code on the back of credit card

 

IXTS Response Codes & Error Messages

Return_Code
Return_Message
Description
0
Unknown Exception An unknown exception
1000
Successful Return when any command is successful
1001
Unknown Command When an invalid string is passed as the REQ_CMD parameter
1002
Required Parameters Missing Missing required fields for the requested command
1003
Invalid User ID or Password Landlord or Property Owner authentication failing
1004
Invalid Credit Card Number Supplied Credit Card is invalid when using UPDATE_CC command
1005
Invalid Credit Card Code Supplied Credit Card Code (CCV) is invalid when using UPDATE_CC command
1006
Insufficient Funds on Credit Card Insufficient funds error attempting to charge card on file
     

 

 

 

 
 
 Home | Products | Pricing | Order | Support | About Us | Contact Us Copyright © 2002 PropertyThree™. All Rights Reserved. Privacy Policy | Terms Of Use