Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cove.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The tenant screening flow is a thorough verification process designed to assess an applicant’s eligibility as a tenant. This flow combines multiple verification steps to evaluate creditworthiness, verify income sources, and assess rental history.

​
Flow Steps

​
1. Identity Verification (ID_VERIFICATION)

Verifies the applicant’s identity using Cove:
  • Government-issued ID verification
  • Selfie verification with liveness detection
  • Background check including watchlist and sanctions
  • Automatic validation with conditional routing
View IDV Step Details

​
2. Employment Verification (EMPLOYMENT)

Validates current employment and income through Argyle or Atomic:
  • Employment status verification
  • Pay slips verification (required)
  • Employer confirmation (required)
  • Income stability assessment
  • Automatic routing based on verification status
View Employment Step Details

​
3. Bank Connection (BANK_CONNECT)

Verifies financial stability through Plaid or Flinks:
  • Account ownership verification
  • Transaction analysis
  • Income stream verification
  • Manual bank statement upload option
View Bank Connect Step Details

​
4. Residence History (RESIDENCE_HISTORY)

Verifies an individual’s residential history through document verification:
  • Address verification
  • Duration of residence
  • Landlord contact information
View Residence History Step Details

​
Flow Configuration

{
  "steps": [
    {
      "id": "6797df4ca4c4910bc0f1d48f",
      "name": "ID_VERIFICATION",
      "options": {
        "require_selfie": true,
        "enable_liveness_detection": true,
        "require_id_back_side": false,
        "run_background_check": {
          "watchlist_check": true,
          "sanctions_check": true
        }
      },
      "control_flow": {
        "condition": {
          "condition_operator": "==",
          "condition_field": "id_valid",
          "condition_value": true
        },
        "if_goto": "6797dfe7a4c4910bc0f1d492",
        "else_goto": "6797fd5e683fb54e8abe7d852"
      },
      "provider": ["Persona"]
    },
    {
      "id": "6797e086a4c4910bc0f1d495",
      "name": "EMPLOYMENT",
      "options": {
        "verify_current_employment": true,
        "verify_income": true,
        "require_pay_stubs": true
      },
      "control_flow": {
        "condition": {
          "condition_operator": "==",
          "condition_field": "employment_status",
          "condition_value": "verified"
        }
      },
      "provider": ["Argyle", "Atomic"]
    },
    {
      "id": "6797e086a4c4910bc0f1d496",
      "name": "BANK_CONNECT",
      "options": {
        "verify_account_balance": true,
        "analyze_transactions": true,
        "verify_account_ownership": true
      },
      "provider": ["Plaid", "Flinks"]
    },
    {
      "id": "6797e086a4c4910bc0f1d498",
      "name": "RESIDENCE_HISTORY",
      "options": {
        "history_years": 3,
        "require_documentation": true,
        "verify_landlord_references": true
      }
    }
  ],
  "options": {
    "send_emails": true,
    "run_credit_check": {
      "fetch_debt_data": true,
      "provider": ["Equifax", "TransUnion"]
    }
  }
}

​
Response

The response will include the screening results and user information. Here’s an example response: 
{
  "screening": {
    "id": "scr_123",
    "checkType": "CHECK_TYPE_DEEP_CHECK",
    "coveScore": 85.5,
    "creditScore": 725,
    "rent": 2000,
    "monthlyIncome": 10000.00,
    "monthlyDebt": 1500.00,
    "totalDebt": 15000.00,
    "debtLimit": 50000.00,
    "monthlyData": [
      {
        "month": "2024-01",
        "averageBalance": 5000.00,
        "income": 10000.00,
        "spending": 4000.00
      }
    ],
    "landlordReviews": [
      {
        "email": "landlord@email.com",
        "phone": "+1987654321",
        "wouldRentToThemAgain": 5,
        "paysRentOnTime": 5,
        "cleanliness": 4,
        "didNotDamageProperty": 5,
        "additionalDetails": "Excellent tenant"
      }
    ],
    "greenFlags": [
      "INCOME_VERIFIED",
      "EMPLOYMENT_VERIFIED",
      "IDENTITY_VERIFIED"
    ]
  },
  "user": {
    "id": "usr_123",
    "identity": {
      "source": "Persona",
      "name": {
        "first": "John",
        "last": "Doe"
      },
      "phone": "+1234567890",
      "email": "john.doe@example.com",
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      },
      "verifications": {
        "liveness": true,
        "faceMatch": true,
        "nameMatch": true
      },
      "at": "2025-02-03T21:37:00-05:00"
    },
    "employment": {
      "employeeType": "FULL_TIME",
      "employmentStatus": "ACTIVE",
      "jobTitle": "Software Engineer",
      "startDate": "2020-01-01T00:00:00Z",
      "weeklyHours": 40,
      "employer": {
        "name": "Acme Corp",
        "address": {
          "line1": "456 Market St",
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94105",
          "country": "US"
        }
      }
    },
    "rentals": [
      {
        "id": "rnt_123",
        "address": {
          "street": "789 Pine St",
          "city": "San Francisco",
          "provinceState": "CA",
          "postalCode": "94105",
          "country": "US"
        },
        "start": "2020-01-01",
        "rentAmount": 2000,
        "landlordName": "Jane Smith",
        "landlordEmail": "jane@email.com",
        "landlordPhone": "+1987654321"
      }
    ]
  }
}

​
Response Fields

​
Screening Object

  • id: Unique identifier for the screening
  • checkType: Type of screening check performed
  • coveScore: Cove’s proprietary scoring
  • creditScore: Credit score if available
  • rent: Monthly rent amount
  • monthlyIncome: Monthly income
  • monthlyDebt: Monthly debt obligations
  • totalDebt: Total debt amount
  • debtLimit: Maximum debt limit
  • monthlyData: Array of monthly financial data
  • landlordReviews: Array of previous landlord reviews
  • greenFlags: Array of positive verification flags

​
User Object

  • id: Unique identifier for the user
  • identity: Identity verification information
  • employment: Employment verification details
  • rentals: Previous rental history