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": "6798005e683fb1e8abe7d854",
    "name": "EMPLOYMENT",
    "options": {
        "require_pay_slips": true,
        "employer_confirmation": true,
        "length_required": 3,
        "require_advisor_verification": true
    },
    "control_flow": {
        "condition": {
            "condition_operator": "==",
            "condition_field": "employment_status",
            "condition_value": "verified"
        },
        "if_goto": "6798015e683fb1e8abe7d855",
        "else_goto": "6797fd5e683fb54e8abe7d852"
    },
    "provider": ["Atomic", "Argyle"]
}

​
Config Fields

​
Required Fields

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

​
Options

  • require_pay_slips: Whether to require recent pay slip documentation
  • employer_confirmation: Whether to verify employment directly with the employer
  • length_required: Minimum length of employment history required
  • require_advisor_verification: Whether to require advisor verification of employment history

​
Control Flow

Determines the next step based on verification results:
  • If employment_status is verified, proceeds to step 6798015e683fb1e8abe7d855

​
Example Response

{
    "employment": {
        "status": "COMPLETED",
        "employment_status": "verified",
        "identity": {
            "firstName": "John",
            "lastName": "Doe",
            "dateOfBirth": "1990-01-15T00:00:00Z",
            "email": "john.doe@example.com",
            "phone": "+14165550123",
            "address": "123 Tech Plaza",
            "city": "Toronto",
            "state": "ON",
            "postalCode": "M5V 2T6",
            "country": "CA"
        },
        "income": {
            "income": 4615.38,
            "incomeType": "SALARY",
            "annualIncome": 120000,
            "hourlyIncome": 57.69,
            "netHourlyRate": 40.38,
            "payCycle": "BI_WEEKLY",
            "nextExpectedPayDate": "2025-02-15T00:00:00Z",
            "currentPayPeriodStart": "2025-02-01T00:00:00Z",
            "currentPayPeriodEnd": "2025-02-15T00:00:00Z",
            "unpaidHoursInPayPeriod": 80
        },
        "employment": {
            "employeeType": "FULL_TIME",
            "employmentStatus": "ACTIVE",
            "jobTitle": "Senior Software Engineer",
            "startDate": "2023-03-15T00:00:00Z",
            "minimumMonthsOfEmployment": 11,
            "weeklyHours": 40,
            "employer": {
                "name": "Tech Corp Inc",
                "address": {
                    "line1": "123 Tech Plaza",
                    "city": "Toronto",
                    "state": "ON",
                    "postalCode": "M5V 2T6",
                    "country": "CA"
                }
            }
        },
        "verification": {
            "provider": "Atomic",
            "verified_at": "2025-02-03T20:25:05-05:00"
        }
    }
}

​
Output Fields

​
Status Information

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

​
Identity Information

  • identity: Personal identification details
    • Basic information like name, date of birth, contact details
    • Current address information

​
Income Information

  • income: Detailed income information
    • Current income and income type
    • Annual and hourly rates
    • Pay cycle and period information
    • Unpaid hours in current period

​
Employment Details

  • employment: Current employment information
    • Employee type and status
    • Job title and start date
    • Work hours and tenure
    • Employer information and address

​
Verification Details

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