Getting screening decisions from PMS
For PMS integrations, Whale automatically checks for the applicant's screening result to determine the appropriate deposit amount to request. Here's where Whale checks for the screening decision for different integrations:
Entrata integrations
Whale looks at the screeningResultStatus on the getLeads endpoint to see if an application is "Approved" or "Approved with conditions".
- If "Approved", Whale will request the Standard deposit amount.
- If "Approved with conditions" AND the property is set to request the conditional deposit for all conditional approvals, Whale will request the Conditional deposit amount.
- If "Approved with conditions" AND the property is configured to request the conditional deposit for a specific conditional reason only, Whale checks the
eventReasonfield on thegetLeadEventsendpoint to see if the specific condition specified in Whale Admin is present.- If present, Whale requests the Conditional deposit amount.
- If not present, Whale requests the Standard deposit amount.
Yardi integrations
Whale looks at the CreditCheckStatus field from the Yardi Guest Card Activity Login endpoint to determine whether an application is "Accepted" or "Conditional".
- If "Accepted", Whale will request the Standard deposit amount.
- If "Conditional" AND the property is configured to request the conditional deposit for all conditional approvals, Whale will request the Conditional deposit amount.
- If "Conditional" AND the property is configured to request the conditional deposit for a specific conditional reason only, Whale checks the
IDScopefield on theCreditCheckStatusnode from theGuest Card Activity Loginendpoint to see if the specific condition specified in Whale Admin is present.- If present, Whale requests the Conditional deposit amount.
- If not present, Whale requests the Standard deposit amount.
RealPage integrations
On the Contact Details report, Whale first checks the Screening Override Decision field and then the Screening Decision field to get the screening decision. If "Approved", Whale requests the Standard deposit amount. If "Approved with conditions", Whale requests the Conditional deposit amount.
Appfolio integrations
Whale checks the approval letter sent to the renter to determine the correct deposit amount to send based on your property configuration.