List all W-2s | SpreadSpace

{
  "borrower_id": "3f9c2b1e8d7a4c5b9e0f1a2b",
  "forms": [
    {
      "extracted_document_id": "7a1d4e9c2b3f4a5d8e6c1b0f",
      "document_category": "w2",
      "report_data": {
        "form": "w2",
        "data": {
          "copy": "B",
          "tax_year": 2025,
          "control_number": "A-1001",
          "employer_ein": "XX-XXX0123",
          "employer_name": "Northfield Supply LLC",
          "employer_address": "100 Harbor Way, Riverton, OH 43000",
          "employee_name": "Ada Marsh",
          "employee_ssn_last4": "1234",
          "box_1_wages": "51400.00",
          "box_2_federal_tax_withheld": "6240.00",
          "box_3_ss_wages": "54000.00",
          "box_4_ss_tax_withheld": "3348.00",
          "box_5_medicare_wages": "54000.00",
          "box_6_medicare_tax_withheld": "783.00",
          "box_7_ss_tips": null,
          "box_8_allocated_tips": null,
          "box_10_dependent_care_benefits": "1200.00",
          "box_11_nonqualified_plans": null,
          "box_12": [
            {
              "code": "D",
              "amount": "2600.00",
              "slot": "a"
            },
            {
              "code": "DD",
              "amount": "8400.00",
              "slot": "b"
            }
          ],
          "box_13_statutory_employee": false,
          "box_13_retirement_plan": true,
          "box_13_third_party_sick_pay": false,
          "box_14_other": [
            {
              "label": "SDI",
              "amount": "468.00"
            },
            {
              "label": "UNION DUES",
              "amount": "300.00"
            }
          ],
          "box_14b_tipped_occupation_codes": [],
          "state_rows": [
            {
              "state": "OH",
              "employer_state_id": "OH-0000123",
              "box_16_state_wages": "54000.00",
              "box_17_state_tax": "1620.00"
            },
            {
              "state": "PA",
              "employer_state_id": "PA-0000456",
              "box_16_state_wages": "2000.00",
              "box_17_state_tax": "60.00"
            }
          ],
          "local_rows": [
            {
              "box_18_local_wages": "54000.00",
              "box_19_local_tax": "540.00",
              "box_20_locality": "RIVERTON"
            }
          ],
          "omb_number": "1545-0008",
          "layout": "irs_1up",
          "source_pages": [
            1
          ],
          "rescued_fields": [],
          "forms_w2": [
            {
              "copy": "B",
              "tax_year": 2025,
              "control_number": "A-1001",
              "employer_ein": "XX-XXX0123",
              "employer_name": "Northfield Supply LLC",
              "employer_address": "100 Harbor Way, Riverton, OH 43000",
              "employee_name": "Ada Marsh",
              "employee_ssn_last4": "1234",
              "box_1_wages": "51400.00",
              "box_2_federal_tax_withheld": "6240.00",
              "box_3_ss_wages": "54000.00",
              "box_4_ss_tax_withheld": "3348.00",
              "box_5_medicare_wages": "54000.00",
              "box_6_medicare_tax_withheld": "783.00",
              "box_7_ss_tips": null,
              "box_8_allocated_tips": null,
              "box_10_dependent_care_benefits": "1200.00",
              "box_11_nonqualified_plans": null,
              "box_12": [
                {
                  "code": "D",
                  "amount": "2600.00",
                  "slot": "a"
                },
                {
                  "code": "DD",
                  "amount": "8400.00",
                  "slot": "b"
                }
              ],
              "box_13_statutory_employee": false,
              "box_13_retirement_plan": true,
              "box_13_third_party_sick_pay": false,
              "box_14_other": [
                {
                  "label": "SDI",
                  "amount": "468.00"
                },
                {
                  "label": "UNION DUES",
                  "amount": "300.00"
                }
              ],
              "box_14b_tipped_occupation_codes": [],
              "state_rows": [
                {
                  "state": "OH",
                  "employer_state_id": "OH-0000123",
                  "box_16_state_wages": "54000.00",
                  "box_17_state_tax": "1620.00"
                },
                {
                  "state": "PA",
                  "employer_state_id": "PA-0000456",
                  "box_16_state_wages": "2000.00",
                  "box_17_state_tax": "60.00"
                }
              ],
              "local_rows": [
                {
                  "box_18_local_wages": "54000.00",
                  "box_19_local_tax": "540.00",
                  "box_20_locality": "RIVERTON"
                }
              ],
              "omb_number": "1545-0008",
              "layout": "irs_1up",
              "source_pages": [
                1
              ],
              "rescued_fields": []
            }
          ],
          "taxpayer_name": "Ada Marsh",
          "ssn_last4": "1234"
        },
        "metadata": {
          "form_key": "w2",
          "detected_year": 2025,
          "parent_form": null,
          "faces_read": 1,
          "copies_collapsed": 0,
          "w2_count": 1,
          "base_page": 0,
          "layout": "irs_1up",
          "standalone": true
        },
        "k1_partners": [],
        "statements": [],
        "depreciation_reports": null
      }
    }
  ]
}

Lists every usable Form W-2 uploaded on its own on the borrower’s file. Duplicates and failed extractions are left out, and you can pass loan_id to narrow the list to one loan.

Requires the extractions:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

borrower_idstringRequired

The borrower's id.

Query parameters

loan_idstringOptional

Narrow the list to one loan.

Response headers

X-Request-IDstringOptional

Correlation ID for this request. Quote it in support tickets.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-07-19.

RateLimit-Limitinteger

Request budget of the endpoint's rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

borrower_idstringformat: "^[0-9a-f]{24}$"

The borrower the documents belong to.

formslist of objects

One row per document.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error