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.

​
Configuration

{
    "id": "6797fd5e683fb1e8abe7d852",
    "name": "ASSETS",
    "options": {
        "verify_net_worth": true,
        "verify_property_ownership": true,
        "validate_closing_costs": true
    },
    "control_flow": {
        "condition": {
            "condition_operator": "==",
            "condition_field": "assets_verified",
            "condition_value": true
        },
        "if_goto": "6798005e683fb1e8abe7d854",
        "else_goto": "6797fd5e683fb54e8abe7d852"
    },
    "provider": ["Plaid", "Flinks"]
}

​
Config Fields

​
Required Fields

  • id: Unique identifier for the verification step
  • name: Step type identifier (ASSETS)

​
Options

  • verify_net_worth: Whether to verify net worth
  • verify_property_ownership: Whether to verify property ownership
  • validate_closing_costs: Whether to validate closing costs

​
Control Flow

Determines the next step based on verification results:
  • If assets_verified is true, proceeds to step 6798005e683fb1e8abe7d854
  • Otherwise, goes to step 6797fd5e683fb54e8abe7d852

​
Providers

  • Primary: Plaid for asset verification and account connections
  • Fallback: Flinks as secondary provider if Plaid connection fails

​
Example Response

{
    "assets": {
        "status": "COMPLETED",
        "assets_verified": true,
        "net_worth": 500000,
        "down_payment": 100000,
        "properties": [{
            "address": "456 Oak St, Toronto, ON",
            "value": 800000,
        }],
        "closing_costs_covered": true,
        "account_balances": [
            {
                "id": "acc_12345",
                "type": "CHECKING",
                "balance": 5432.10,
                "institution": {
                    "id": "ins_td",
                    "name": "TD Bank"
                }
            },
            {
                "id": "acc_67890",
                "type": "SAVINGS",
                "balance": 15000.00,
                "institution": {
                    "id": "ins_td",
                    "name": "TD Bank"
                }
            }
        ],
        "monthly_data": [
            {
                "month": "2025-01",
                "average_balance": 19245.75,
                "income": 4615.38,
                "spending": 3200.50
            },
            {
                "month": "2024-12",
                "average_balance": 18830.87,
                "income": 4615.38,
                "spending": 3500.25
            }
        ],
        "verification": {
            "provider": "Plaid",
            "verified_at": "2025-02-03T20:25:05-05:00"
        }
    }
}

​
Output Fields

​
Status Information

  • status: Current status of the verification (e.g., “COMPLETED”)
  • assets_verified: Whether all assets were successfully verified

​
Net Worth and Down Payment

  • net_worth: Total net worth
  • down_payment: Total down payment

​
Property Information

  • properties: List of properties
    • Property address
    • Property value
    • HELOC

​
Closing Costs

  • closing_costs_covered: Whether closing costs are covered

​
Account Information

  • account_balances: List of connected bank accounts
    • Account details including ID, type, and balance
    • Institution information

​
Monthly Analysis

  • monthly_data: Monthly financial analysis
    • Average balance for each month
    • Total income and spending

​
Verification Details

  • verification: Information about the verification process
    • provider: Which provider performed the verification
    • verified_at: When verification was completed