Reports

Get reports for an applicant group

get

https://api.payscore.comhttps://staging.api.payscore.com

/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

bearerAuth

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

401

Unauthorized - invalid or missing authentication token

404

Applicant group not found

get

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

HTTPcURLJavaScriptPython

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

https://api.payscore.comhttps://staging.api.payscore.com

/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

bearerAuth

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

404

Report not found

410

Report data has expired and is no longer available

get

/api/v1/reports/{id}

HTTPcURLJavaScriptPython

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": {
    "summary": {
      "total_monthly_income": 450000,
      "income_to_rent_ratio": 3.2,
      "recommendation": "approve"
    },
    "accounts": [
      {
        "account_id": "text",
        "institution_name": "Chase Bank",
        "account_type": "checking",
        "monthly_income": 350000
      }
    ],
    "transactions": [
      {
        "date": "2025-12-29",
        "amount": 1,
        "description": "Direct Deposit - ACME CORP"
      }
    ]
  }
}