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": "6797dfb4a4c4910bc0f1d491",
    "name": "RESIDENCE_HISTORY",
    "options": {
        "length_required": 3,
        "require_advisor_verification": true
    },
    "control_flow": {
        "condition": {
            "condition_operator": "==",
            "condition_field": "residence_verified",
            "condition_value": true
        },
        "if_goto": "6797dfe7a4c4910bc0f1d492",
        "else_goto": "6797fd5e683fb54e8abe7d852"
    },
    "provider": []
}

​
Config Fields

​
Required Fields

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

​
Control Flow

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

​
Providers

No external providers - residence history verification is handled internally by Cove.

​
Example Response

{
    "residence_history": {
        "status": "COMPLETED",
        "residence_verified": true,
        "residences": [
            {
                "address": "789 Oak Lane",
                "city": "Toronto",
                "state": "ON",
                "postalCode": "M5V 2T6",
                "start_date": "2020-01-01",
                "end_date": "2021-01-01",
                "landlord_name": "John Smith",
                "landlord_phone": "+14165550123"
            },
            {
                "address": "123 Maple St",
                "city": "Toronto",
                "state": "ON",
                "postalCode": "M5V 2T6",
                "start_date": "2021-01-02",
                "end_date": "2022-01-01",
                "landlord_name": "Jane Doe",
                "landlord_phone": "+14165550124"
            }
        ],
        "verification": {
            "verified_at": "2025-02-03T20:25:05-05:00"
        }
    }
}

​
Output Fields

​
Status Information

  • status: Current status of the verification (e.g., “COMPLETED”)
  • residence_verified: Whether the residence history was successfully verified

​
Residence Information

  • residences: List of verified residences
    • Address details including street, city, state, and postal code
    • Dates of residence and landlord information

​
Verification Details

  • verification: Information about the verification process
    • verified_at: When verification was completed