Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reports

Get reports for an applicant group

get
/api/v1/applicant_groups/{id}/reports

Retrieves all household and individual reports associated with a specific applicant group. Returns both household-level reports (aggregated across all applicants) and individual applicant reports.

Authorizations
AuthorizationstringRequired

JWT token obtained from the /api/v1/tenants/auth endpoint. Token expires after 30 minutes and must be refreshed.

Example: Authorization: Bearer eyJhbGciOiJIUzI1NiJ9...

Path parameters
idstring · uuidRequired

Unique identifier of the applicant group

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Reports retrieved successfully

application/json
get/api/v1/applicant_groups/{id}/reports
GET /api/v1/applicant_groups/{id}/reports HTTP/1.1
Host: api.payscore.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "household_reports": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "report_name": "Income",
      "is_expired": false,
      "created_at": "2024-01-01T12:00:00Z",
      "applicant_group_id": "550e8400-e29b-41d4-a716-446655440001",
      "applicant_id": "550e8400-e29b-41d4-a716-446655440002",
      "path": "/reports/550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "individual_reports": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "report_name": "Income",
      "is_expired": false,
      "created_at": "2024-01-01T12:00:00Z",
      "applicant_group_id": "550e8400-e29b-41d4-a716-446655440001",
      "applicant_id": "550e8400-e29b-41d4-a716-446655440002",
      "path": "/reports/550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

Get report data

get
/api/v1/reports/{id}

Retrieves the data for a specific report. The response structure varies based on the report type (income, identity, or asset verification).

Authorizations
AuthorizationstringRequired

JWT token obtained from the /api/v1/tenants/auth endpoint. Token expires after 30 minutes and must be refreshed.

Example: Authorization: Bearer eyJhbGciOiJIUzI1NiJ9...

Path parameters
idstring · uuidRequired

Unique identifier of the report

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Report data retrieved successfully

application/json

Wrapper response containing report data that varies by report type, including PDF download URL

report_idstring · uuidRequired

Unique identifier for the report

Example: 550e8400-e29b-41d4-a716-446655440000
report_typestring · enumRequired

Type of report data contained in this response

Possible values:
applicant_group_idstring · uuidRequired

Unique identifier for the applicant group this report belongs to

Example: 550e8400-e29b-41d4-a716-446655440001
applicant_idstring · uuidOptional

Unique identifier for the individual applicant (only present for individual reports, not household reports)

Example: 550e8400-e29b-41d4-a716-446655440002
pdf_urlstring · uriRequired

Secure URL to download the PDF report (expires in 2 hours)

Example: https://s3.amazonaws.com/payscore-reports/reports/550e8400-e29b-41d4-a716-446655440000.pdf?AWSAccessKeyId=AKIA...&Expires=1640995200&Signature=...
dataone ofRequired
or
or
get/api/v1/reports/{id}
GET /api/v1/reports/{id} HTTP/1.1
Host: api.payscore.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "report_id": "550e8400-e29b-41d4-a716-446655440000",
  "report_type": "income",
  "applicant_group_id": "550e8400-e29b-41d4-a716-446655440001",
  "applicant_id": "550e8400-e29b-41d4-a716-446655440002",
  "pdf_url": "https://s3.amazonaws.com/payscore-reports/reports/550e8400-e29b-41d4-a716-446655440000.pdf?AWSAccessKeyId=AKIA...&Expires=1640995200&Signature=...",
  "data": {
    "reports": [
      {
        "verification_id": "550e8400-e29b-41d4-a716-446655440000",
        "identity": {
          "full_name": "Jane Smith",
          "email": "jane@example.com"
        },
        "reason_completed": "text",
        "income_sources": [
          {
            "source": "bank"
          }
        ],
        "recurring": {
          "total": 900000,
          "one_month_avg_monthly": 450000,
          "two_month_avg_monthly": 445000,
          "three_month_avg_monthly": 440000,
          "six_month_avg_monthly": 435000,
          "nine_month_avg_monthly": 430000,
          "twelve_month_avg_monthly": 425000,
          "income_streams": [
            {
              "name": "ACME CORP DIRECT DEP",
              "total": 450000,
              "monthly_income": 150000,
              "start_date": "2024-09-01",
              "end_date": "2024-11-30",
              "transactions": [
                {
                  "name": "ACME CORP DIRECT DEP",
                  "amount": 150000,
                  "date": "11/15/2024"
                }
              ],
              "paystubs": [
                {
                  "gross_pay": 562500,
                  "base_pay": 500000,
                  "bonus": 25000,
                  "commission": 37500,
                  "tips": 0,
                  "overtime": 0,
                  "other": 0,
                  "net_pay": 450000,
                  "hours_worked": 80,
                  "pay_date": "November 15, 2024",
                  "start_date": "November 1, 2024",
                  "end_date": "November 15, 2024"
                }
              ],
              "pay_gap_after_transaction_indexes": [
                1
              ]
            }
          ]
        },
        "non_recurring": {
          "total": 50000,
          "one_month_avg_monthly": 1,
          "two_month_avg_monthly": 1,
          "three_month_avg_monthly": 1,
          "six_month_avg_monthly": 1,
          "nine_month_avg_monthly": 1,
          "twelve_month_avg_monthly": 1,
          "income_streams": [
            {
              "name": "ACME CORP DIRECT DEP",
              "total": 450000,
              "monthly_income": 150000,
              "start_date": "2024-09-01",
              "end_date": "2024-11-30",
              "transactions": [
                {
                  "name": "ACME CORP DIRECT DEP",
                  "amount": 150000,
                  "date": "11/15/2024"
                }
              ],
              "paystubs": [
                {
                  "gross_pay": 562500,
                  "base_pay": 500000,
                  "bonus": 25000,
                  "commission": 37500,
                  "tips": 0,
                  "overtime": 0,
                  "other": 0,
                  "net_pay": 450000,
                  "hours_worked": 80,
                  "pay_date": "November 15, 2024",
                  "start_date": "November 1, 2024",
                  "end_date": "November 15, 2024"
                }
              ],
              "pay_gap_after_transaction_indexes": [
                1
              ]
            }
          ]
        },
        "summary_timespan_length": 91,
        "bank_connections": [
          {
            "institution_name": "Chase Bank",
            "accounts": [
              {}
            ],
            "income": {
              "total": 450000,
              "two_month_avg_monthly": 1,
              "three_month_avg_monthly": 1,
              "six_month_avg_monthly": 1,
              "nine_month_avg_monthly": 1,
              "twelve_month_avg_monthly": 1,
              "income_streams": [
                {
                  "name": "ACME CORP DIRECT DEP",
                  "total": 450000,
                  "monthly_income": 150000,
                  "start_date": "2024-09-01",
                  "end_date": "2024-11-30",
                  "transactions": [
                    {
                      "name": "ACME CORP DIRECT DEP",
                      "amount": 150000,
                      "date": "11/15/2024"
                    }
                  ],
                  "paystubs": [
                    {
                      "gross_pay": 562500,
                      "base_pay": 500000,
                      "bonus": 25000,
                      "commission": 37500,
                      "tips": 0,
                      "overtime": 0,
                      "other": 0,
                      "net_pay": 450000,
                      "hours_worked": 80,
                      "pay_date": "November 15, 2024",
                      "start_date": "November 1, 2024",
                      "end_date": "November 15, 2024"
                    }
                  ],
                  "pay_gap_after_transaction_indexes": [
                    1
                  ]
                }
              ],
              "non_recurring": {
                "total": 1,
                "income_streams": [
                  {
                    "name": "ACME CORP DIRECT DEP",
                    "total": 450000,
                    "monthly_income": 150000,
                    "start_date": "2024-09-01",
                    "end_date": "2024-11-30",
                    "transactions": [
                      {
                        "name": "ACME CORP DIRECT DEP",
                        "amount": 150000,
                        "date": "11/15/2024"
                      }
                    ],
                    "paystubs": [
                      {
                        "gross_pay": 562500,
                        "base_pay": 500000,
                        "bonus": 25000,
                        "commission": 37500,
                        "tips": 0,
                        "overtime": 0,
                        "other": 0,
                        "net_pay": 450000,
                        "hours_worked": 80,
                        "pay_date": "November 15, 2024",
                        "start_date": "November 1, 2024",
                        "end_date": "November 15, 2024"
                      }
                    ],
                    "pay_gap_after_transaction_indexes": [
                      1
                    ]
                  }
                ]
              },
              "start_date": "2024-09-01",
              "end_date": "2024-11-30",
              "transaction_timespan_length": 91
            }
          }
        ],
        "payroll_connections": [
          {
            "employee_name": "Jane Smith",
            "company_name": "Acme Corp",
            "institution_name": "ADP",
            "company_address": "123 Main St, San Francisco, CA 94102",
            "title": "Software Engineer",
            "start_date": "January 1, 2023",
            "end_date": null,
            "pay_frequency": "Biweekly",
            "pay_rate": "Annual",
            "pay_amount": 10000000,
            "income": {
              "total": 1,
              "two_month_avg_monthly": 1,
              "three_month_avg_monthly": 1,
              "six_month_avg_monthly": 1,
              "nine_month_avg_monthly": 1,
              "twelve_month_avg_monthly": 1,
              "income_streams": [
                {
                  "name": "ACME CORP DIRECT DEP",
                  "total": 450000,
                  "monthly_income": 150000,
                  "start_date": "2024-09-01",
                  "end_date": "2024-11-30",
                  "transactions": [
                    {
                      "name": "ACME CORP DIRECT DEP",
                      "amount": 150000,
                      "date": "11/15/2024"
                    }
                  ],
                  "paystubs": [
                    {
                      "gross_pay": 562500,
                      "base_pay": 500000,
                      "bonus": 25000,
                      "commission": 37500,
                      "tips": 0,
                      "overtime": 0,
                      "other": 0,
                      "net_pay": 450000,
                      "hours_worked": 80,
                      "pay_date": "November 15, 2024",
                      "start_date": "November 1, 2024",
                      "end_date": "November 15, 2024"
                    }
                  ],
                  "pay_gap_after_transaction_indexes": [
                    1
                  ]
                }
              ],
              "start_date": "2024-09-01",
              "end_date": "2024-11-30",
              "transaction_timespan_length": 91
            },
            "is_name_mismatched": false
          }
        ],
        "income_explanation": "text",
        "uploaded_documents": [
          {
            "name": "Nov 1, 2025 – Nov 15, 2025 - Payscore Inc.pdf",
            "type": "paystub",
            "fraud_risk": "low",
            "fraud_risk_score": 20,
            "applicant_name": "Jane Smith",
            "fraud_risk_signals": [
              {
                "type": "Font",
                "description": "Creation date and modification date do not match"
              }
            ]
          }
        ]
      }
    ],
    "recurring": {
      "total": 900000,
      "one_month_avg_monthly": 450000,
      "two_month_avg_monthly": 445000,
      "three_month_avg_monthly": 440000,
      "six_month_avg_monthly": 435000,
      "nine_month_avg_monthly": 430000,
      "twelve_month_avg_monthly": 425000,
      "income_streams": [
        {
          "name": "ACME CORP DIRECT DEP",
          "total": 450000,
          "monthly_income": 150000,
          "start_date": "2024-09-01",
          "end_date": "2024-11-30",
          "transactions": [
            {
              "name": "ACME CORP DIRECT DEP",
              "amount": 150000,
              "date": "11/15/2024"
            }
          ],
          "paystubs": [
            {
              "gross_pay": 562500,
              "base_pay": 500000,
              "bonus": 25000,
              "commission": 37500,
              "tips": 0,
              "overtime": 0,
              "other": 0,
              "net_pay": 450000,
              "hours_worked": 80,
              "pay_date": "November 15, 2024",
              "start_date": "November 1, 2024",
              "end_date": "November 15, 2024"
            }
          ],
          "pay_gap_after_transaction_indexes": [
            1
          ]
        }
      ]
    },
    "non_recurring": {
      "total": 50000,
      "one_month_avg_monthly": 1,
      "two_month_avg_monthly": 1,
      "three_month_avg_monthly": 1,
      "six_month_avg_monthly": 1,
      "nine_month_avg_monthly": 1,
      "twelve_month_avg_monthly": 1,
      "income_streams": [
        {
          "name": "ACME CORP DIRECT DEP",
          "total": 450000,
          "monthly_income": 150000,
          "start_date": "2024-09-01",
          "end_date": "2024-11-30",
          "transactions": [
            {
              "name": "ACME CORP DIRECT DEP",
              "amount": 150000,
              "date": "11/15/2024"
            }
          ],
          "paystubs": [
            {
              "gross_pay": 562500,
              "base_pay": 500000,
              "bonus": 25000,
              "commission": 37500,
              "tips": 0,
              "overtime": 0,
              "other": 0,
              "net_pay": 450000,
              "hours_worked": 80,
              "pay_date": "November 15, 2024",
              "start_date": "November 1, 2024",
              "end_date": "November 15, 2024"
            }
          ],
          "pay_gap_after_transaction_indexes": [
            1
          ]
        }
      ]
    },
    "summary_timespan_length": 91,
    "criteria_rule_results": [
      {
        "result": "passed",
        "multiplier_result": "passed",
        "multiplier_threshold": 3,
        "criteria_used": "three_month_avg_monthly",
        "criteria_from_rule": "rent_limit"
      }
    ],
    "applicant_group_id": "550e8400-e29b-41d4-a716-446655440001",
    "property_name": "ABC Apartments",
    "property_monthly_rent_cents": 150000,
    "created_at": "2026-01-01T00:00:00.000Z",
    "uploaded_documents": [
      {
        "name": "Nov 1, 2025 – Nov 15, 2025 - Payscore Inc.pdf",
        "type": "paystub",
        "fraud_risk": "low",
        "fraud_risk_score": 20,
        "applicant_name": "Jane Smith",
        "fraud_risk_signals": [
          {
            "type": "Font",
            "description": "Creation date and modification date do not match"
          }
        ]
      }
    ]
  }
}
PreviousApplicant GroupsNextModels

Last updated