Payscore
  • Introduction
  • Authentication
  • Sending Income Verification Requests
    • Creating a Screening Group
    • Receiving Status Updates
    • Webhooks
    • Resend Screening Request Notification
    • Force-Complete a Screening Group Request
    • Get All Screening Groups
    • Delete a Screening Group
  • Reports
    • Getting the Report Url
    • Getting the Report Data
  • Using Demo Bank Data
Powered by GitBook
On this page
  1. Sending Income Verification Requests

Get All Screening Groups

You can get all screening groups paginated with the following route:

Get Screening Groups

GET https://api.payscore.com/api/v1/screening_groups

Get all screening groups paginated

Query Parameters

Name
Type
Description

page

String

The page of all entities you want to pul. The number of records returned in each page is 25.

{
    "screening_groups": [{
        "id": "905963d4-0649-4046-8f39-7997a9e45ed4",
        "screenings": [{
            "id": "4516efb4-82ed-43cd-a55a-ba93d4914562",
            "applicant_first_name": "John",
            "applicant_last_name": "Smith",
            "applicant_email": "johnsmith@gmail.com",
            "reason_completed": "not_completed",
            "screening_status": "not_started"
        }, {
            "id": "13cc2254-152e-4e78-937c-66b7d89c65a2",
            "applicant_first_name": "Bob",
            "applicant_last_name": "Thomas",
            "applicant_email": "bobthomas@gmail.com",
            "reason_completed": "finished",
            "screening_status": "completed"
        }],
        "status": "in_progress",
        "approval_recommendation": "unavailable",
        "property_name": "Test Property",
        "property_street_address": "1234 Pike St.",
        "unit_number": "#101",
        "monthly_rent_cents": 200000,
        "is_decision_maker_paying": true,
        "is_report_expired": false,
        "is_report_expired": null,
        "created_at_timestamp": 1574244834717.303
    },
    "total_count": 1
}

PreviousForce-Complete a Screening Group RequestNextDelete a Screening Group

Last updated 2 years ago