---
title: "Get the screening data"
method: GET
path: "/v1/screening/data/{userId}"
tags: ["Screening V1"]
---

# Get the screening data

`GET /v1/screening/data/{userId}`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/screening/data/{userId}`
- Auth: API key in header `Authorization`

Get the screening data

## Path parameters

- `userId` string, required

## Response `200`

A successful response.

- V1GetScreeningDataResponse
  - `screening` V1Screening
    - `id` string
    - `metadata` object
    - `checkType` string
    - `coveScore` number, double
    - `creditScore` integer
    - `equifaxResult` object
    - `flinksBankAccounts` V1FlinksBankAccount[]
      - `accountNumber` string
      - `accountType` string
      - `balance` FlinksBankAccountBalance
        - `available` number, double
        - `current` number, double
        - `limit` string, int64
      - `category` string
      - `currency` string
      - `holder` FlinksBankAccountHolder
        - `address` FlinksBankAccountHolderAddress
          - `city` string
          - `civicAddress` string
          - `country` string
          - `poBox` string
          - `postalCode` string
          - `province` string
        - `email` string
        - `name` string
        - `phoneNumber` string
      - `id` string
      - `institutionNumber` string
      - `title` string
      - `transactions` FlinksBankAccountTransaction[]
        - `balance` number, double
        - `credit` number, double
        - `date` string
        - `debit` number, double
        - `description` string
        - `id` string
      - `transitNumber` string
      - `type` string
    - `greenFlags` string[]
    - `incomeTransactions` V1IncomeTransaction[]
      - `accountId` string
      - `amount` number, double
      - `date` string
      - `isoCurrencyCode` string
      - `originalDescription` string
      - `pending` boolean
      - `transactionId` string
    - `landlordReviews` ScreeningLandlordReview[]
      - `email` string
      - `phone` string
      - `wouldRentToThemAgain` integer
      - `paysRentOnTime` integer
      - `cleanliness` integer
      - `didNotDamageProperty` integer
      - `additionalDetails` string
    - `monthlyData` ScreeningMonthlyData[]
      - `averageBalance` number, double
      - `income` number, double
      - `month` string
      - `spending` number, double
    - `nonSufficientFunds` V1NSF[]
      - `dateReported` string, date-time
      - `creditorEntity` string
      - `nsfamount` number, double
      - `details` string
      - `verificationDate` string, date-time
    - `normBAB` number, double
    - `normCSC` number, double
    - `normECS` number, double
    - `normMI` number, double
    - `redFlags` string[]
    - `reportStatus` string
    - `scanStatus` ScreeningScanStatus
      - `criminalScan` string
      - `criminalScanLabel` string
      - `fraudScan` string
      - `fraudScanLabel` string
      - `globalClearanceScan` string
      - `globalClearanceScanLabel` string
      - `knownAffiliationScan` string
      - `knownAffiliationScanLabel` string
      - `ofacGlobalTerroristScan` string
      - `ofacGlobalTerroristScanLabel` string
      - `otherScan` string
      - `otherScanLabel` string
      - `politicallyExposedPersonScan` string
      - `politicallyExposedPersonScanLabel` string
      - `publicCourtRecords` string
      - `publicCourtRecordsLabel` string
      - `publicProfileScan` string
      - `publicProfileScanLabel` string
      - `publicSafetyScan` string
      - `publicSafetyScanLabel` string
      - `sexOffenderScan` string
      - `sexOffenderScanLabel` string
    - `rentTransactions` ScreeningRentTransaction[]
      - `id` string
      - `type` string
      - `amount` number, double
      - `isoCurrencyCode` string
      - `description` string
      - `date` string
    - `updatedAt` string, date-time
    - `customFormData` ScreeningCustomFormData[]
      - `question` string
      - `value` string
      - `type` string
    - `monthlyIncome` number, double
    - `monthlyDebt` number, double
    - `debtLimit` number, double
    - `rent` integer
    - `publicRecords` V1ScreeningPublicRecord[]
      - `topic` string
      - `matchConfidence` number, double
      - `landlordName` string
      - `amountOwed` number, double
      - `url` string
    - `autoLoansMonthlyPayments` number, double
    - `autoLoansTotalBalance` number, double
    - `revolvingCreditMonthlyPayments` number, double
    - `revolvingCreditTotalBalance` number, double
    - `otherCreditMonthlyPayments` number, double
    - `otherCreditTotalBalance` number, double
    - `otherDebtsMonthlyPayments` number, double
    - `otherDebtsTotalBalance` number, double
    - `mortgageLoansMonthlyPayments` number, double
    - `mortgageLoansTotalBalance` number, double
    - `studentLoansMonthlyPayments` number, double
    - `studentLoansTotalBalance` number, double
    - `totalCurrentBankBalance` number, double
    - `totalDebt` number, double
  - `user` V1User
    - `id` string
    - `phoneNumber` string
    - `proofOfIncome` string[]
    - `checkComplete` boolean
    - `idPhotoUrls` string[]
    - `selfieUrls` string[]
    - `rentals` UserRentals[]
      - `address` V1UserCoveAddress
        - `street` string
        - `city` string
        - `provinceState` string
        - `country` string
        - `postalCode` string
        - `fullAddress` string
      - `start` string
      - `reasonForMoving` string
      - `rentAmount` integer
      - `landlordName` string
      - `landlordEmail` string
      - `landlordPhone` string
      - `id` string
    - `addressOnId` V1UserCoveAddress
      - `street` string
      - `city` string
      - `provinceState` string
      - `country` string
      - `postalCode` string
      - `fullAddress` string
    - `currentAddress` V1UserCoveAddress
      - `street` string
      - `city` string
      - `provinceState` string
      - `country` string
      - `postalCode` string
      - `fullAddress` string
    - `dateOfBirth` string
    - `firstName` string
    - `identityVerification` UserIdentityVerification
      - `source` string
      - `name` V1UserName
        - `first` string
        - `last` string
      - `phone` string
      - `email` string
      - `address` UserCommonAddress
        - `line1` string
        - `line2` string
        - `city` string
        - `state` string
        - `postalCode` string
        - `country` string
      - `verifications` V1UserVerifications
        - `liveness` boolean
        - `faceMatch` boolean
        - `nameMatch` boolean
      - `idNumber` string
      - `at` string, date-time
    - `lastName` string
    - `email` string
    - `employmentAnnualSalary` number, double
    - `employmentCompanyName` string
    - `employmentCompanyPosition` string
    - `employmentReferenceFirstName` string
    - `employmentReferenceLastName` string
    - `employmentReferencePhoneNumber` string
    - `employmentReferenceWorkEmail` string
    - `employmentStartDate` string
    - `employmentStatus` string
    - `reasonForMoving` string
    - `residentialStatus` string
    - `employmentDetails` V1UserEmploymentDetails
      - `identity` V1UserIdentity
        - `firstName` string
        - `lastName` string
        - `dateOfBirth` string, date-time
        - `email` string
        - `phone` string
        - `ssn` string
        - `address` string
        - `city` string
        - `state` string
        - `postalCode` string
      - `income` V1UserIncome
        - `income` number, double
        - `incomeType` string
        - `annualIncome` string, uint64
        - `hourlyIncome` number, double
        - `netHourlyRate` number, double
        - `payCycle` string
        - `nextExpectedPayDate` string, date-time
        - `currentPayPeriodStart` string, date-time
        - `currentPayPeriodEnd` string, date-time
      - `employment` V1UserEmployment
        - `employeeType` string
        - `employmentStatus` string
        - `jobTitle` string
        - `startDate` string, date-time
        - `minimumMonthsOfEmployment` integer
        - `weeklyHours` integer
        - `employer` V1UserEmployer
          - `name` string
          - `address` UserCommonAddress
            - `line1` string
            - `line2` string
            - `city` string
            - `state` string
            - `postalCode` string
            - `country` string

## Other responses

- `default`: An unexpected error response.

## Changes

- **2025-06-23** `90c3e5a0851d`: 1 info
  - added the optional property `screening/publicRecords` to the response with the `200` status
- **2025-06-03** `d073d48df6b1`: 14 breaking, 4 warning, 50 info
  - the `screening/autoLoansMonthlyPayments` response's property type changed from `string` to `number`, and format from no format to `double` for status `200`
  - the `screening/autoLoansTotalBalance` response's property type changed from `string` to `number`, and format from no format to `double` for status `200`
  - the `screening/mortgageLoansMonthlyPayments` response's property type changed from `string` to `number`, and format from no format to `double` for status `200`
  - the `screening/mortgageLoansTotalBalance` response's property type changed from `string` to `number`, and format from no format to `double` for status `200`
  - …64 more
- **2025-02-02** `d22701eae819`: 1 info
  - endpoint added
- **2025-02-02** `67b7e6175415`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto/changes/v1/screening/data/:userId/get.md)

---

[API](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto.md) - [All operations](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto/llms.txt) - [OpenAPI document](https://skmtc.dev/getcove/apis/proto-screening-v2-screening-proto/revisions/9d9f9d9f0188?raw)