Skip to main content

Yardi Integration Setup

Step-by-step instructions for setting up the Payscore integration in Yardi

Written by Stephen Arifin
Updated this week

This article walks through how to set up the Payscore integration in Yardi so that income and identity verification invitations and reports flow automatically.

This setup is typically completed by someone with Yardi administrative access.


Before you begin

To complete setup, you’ll need:

  • Access to Yardi Voyager with admin permissions

  • Ability to configure ILS / Guest Card interfaces

  • A Yardi interface user with read/write permissions

If Payscore does not appear as an available vendor in your Yardi instance, you’ll need to contact Yardi Technical Support to have the vendor package loaded before continuing.


Step 1: Configure the Payscore vendor interface

  1. In Yardi, go to Interfaces → Review Interface Vendors


  2. Select Entity Type: ILS / Guest Card

  3. Click Submit


Configure interface settings

Search for Payscore in the Interface Configuration screen. If you do not see this option, you will need to contact Yardi Technical Support to load the vendor package into your instance.


Configure the following required settings:

Prospect activity window

Set “Include only Residents/Guests with activity in the last” to 14 days

  • This controls how much prospect data Payscore can access

Attachment types

  • Select the attachment types Payscore will use to upload:

    • Income reports

    • Identity verification reports

  • You may create new attachment types or reuse existing ones

  • Make sure that they are highlighted in the UI. That allows Payscore to have access to those attachment types

Click Save


Step 2: Enable Payscore at the property level

  1. Go to Setup → Property → Find Property

  2. Enter the property code and click Submit

  3. Open the Functions menu

  4. Select Interface Configuration

  5. Click ILS / Guest Card on the left

  6. Move Payscore from Available Agencies to Agencies Selected for Property

  7. Click Save


Step 3: Create an interface user for Payscore

Payscore requires a dedicated interface user to access Yardi via web services.

  1. Go to System Administration → Security → Add User

  2. Create a new user for Payscore

  3. Assign the user to a security group with:

    • Read/Write access to ILS / Guest Card


Configure interface user permissions

  1. Enter the property code in the property field

    • This limits access to properties enabled for Payscore

  2. Open the Privileges tab

  3. Select Interface User

    • This allows web services access without Voyager UI access

  4. Click Save


Step 4: Send access details to Payscore

Once setup is complete, send the following information to Payscore so the integration can be activated:

  • Voyager URL

  • Interface username and password

  • Database name

  • Server name

  • Attachment types selected for:

    • Income reports

    • Identity verification reports

  • Yardi Property Code(s)

The Voyager URL, database, and server name can be found on the About page in Yardi.


After setup is complete

Once Payscore enables the integration:

  • Verification invites will be sent automatically when applications are submitted

  • Reports will upload directly into Yardi

  • No manual action is required from leasing teams

(See Yardi Integration Overview for details on how the workflow behaves after setup.)


Common setup issues

  • Payscore not listed as a vendor

    → Contact Yardi Technical Support to load the vendor package

  • Payscore has no access to data

    → Set “Include only Residents/Guests with activity in the last” to 14 days in Step 1

  • Invites not sending

    → Confirm rental amount and applicant email are populated in Yardi

Did this answer your question?