---
title: "Retrieve an order"
method: GET
path: "/v1/orders/{id}/"
tags: ["Orders"]
---

# Retrieve an order

`GET /v1/orders/{id}/`

The endpoint returns the order.

## Query parameters

- `certification` 'all' | 'certified'

## Response `200`

- union
  - OrderRetrieveResponse
    - `id` string, required — Unique ID
    - `products` string[], required — Types of products selected for the order
    - `source` 'floify' | 'besmartee' | 'lenderlogix' | 'encompass_consumer_connect' | 'byte' | 'core_logic' | 'xactus' | 'constellation' | 'banno' | 'mx' | 'q2' | 'clutch' | 'accio' | 'encompass' | 'tpo_connect' | 'darkmatter' | 'tazworks' | 'internal' | 'simplenexus' | 'external_webpage' | 'individual' | 'alkami' | 'blue_sage' | 'lodasoft' | 'blend' | 'tidalwave' | 'self_signup', required — Type of the platform (internal, accio, etc.)
    - `order_number` string, nullable — External ID
    - `custom_field` string, nullable — User provided custom field. Must be enabled in the customization section.
    - `client_name` string, required — Client name displayed on the order page
    - `first_name` string, required — First name
    - `last_name` string, required — Last name
    - `user_id` string, required — Unique Truv ID of the user.
    - `bridge_token` string — UUID value of bridge token
    - `share_url` string, nullable, required — Landing page URL to share
    - `created_at` string, date-time, required — Date and time when order was created
    - `updated_at` string, date-time — Date and time when order was updated
    - `canceled_at` string, date-time, nullable — Date and time when order was canceled
    - `completed_at` string, date-time, nullable — Date and time when order was successfully completed
    - `expired_at` string, date-time, required — Date and time when order would expire
    - `is_expired` boolean, required — If order is already expired
    - `user_consent_at` string, date-time, nullable — Date and time when explicit user consent was given
    - `initial_order` string, nullable — ID of an origin order if the order was created by the order data refresh operation
    - `refresh_order` string, nullable — ID of the last refresh order created by the order data refresh operation for the order
    - `employers` EmployerResponse[], required — List of employers
      - `id` string, required — Unique ID
      - `product_type` 'income' | 'employment' | 'deposit_switch' | 'pll' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, required — Date and time when order was created
      - `bridge_token` string — UUID value of bridge token
      - `link_id` string, nullable — Link ID for the connected account
      - `access_token` string, nullable — Access token to perform data refresh
      - `pdf_report` string, uri, nullable — Verification report in PDF format
      - `data_source` 'payroll' | 'docs' | 'tax' | 'financial_accounts' | 'null', nullable — Source of data: payroll - payroll provider parsing, docs - user uploaded documents, tax - tax documents, financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `last_task_status` 'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' | 'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'switch_deposit' | 'session_expired' | 'null', nullable — Status of the most recent [task](/api-reference/tasks/lifecycle) for the connection. Terminal statuses are `done`, `error`, `login_error`, `account_locked`, `mfa_error`, `config_error`, `no_data`, `unavailable`, `unable_to_reset`, and `not_supported`. The remaining values are in-progress statuses that appear while a verification is still running. Returns `null` when no task exists for the connection yet.
      - `start_date` string, nullable — Employment start date
      - `end_date` string, nullable — Employment start date
      - `company_name` string, nullable — Company name
      - `company_address` object, nullable — Company address
        - `street` string, required — Company location street. Returned exactly as provided when the order was created, and may contain multiple lines separated by `\n`.
        - `city` string, required — Company location city. Returned exactly as provided when the order was created.
        - `state` string, required — Company location state. Typically a 2-letter state code; international region codes such as `NSW` are also accepted. Returned exactly as provided when the order was created.
        - `zip` string, required — Company location zip code. Typically a 5-digit US ZIP code; ZIP+4 and non-US postal codes also occur. Returned exactly as provided when the order was created.
      - `company_domain` string, nullable — Company website domain
      - `company_logo` string, uri, nullable — Company logo URL
      - `employments` object[], nullable, required — List of employments
        - `income` string, decimal, nullable — Income amount not including commission or bonuses (only for income product)
        - `income_unit` 'YEARLY' | 'MONTHLY' | 'WEEKLY' | 'DAILY' | 'HOURLY' | 'null', nullable — The pay interval the income field refers to: * `YEARLY` - Annual income, * `MONTHLY` - Monthly income, * `WEEKLY` - Weekly income, * `DAILY` - Daily income, * `HOURLY` - Hourly income (only for income product)
        - `pay_rate` string, decimal, nullable — Payment rate per pay cycle (only for income product)
        - `pay_frequency` 'M' | 'SM' | 'W' | 'BW' | 'A' | 'SA' | 'C' | 'null', nullable — Pay frequency: * `M` - Monthly, * `SM` - Semi-Monthly, * `W` - Weekly, * `BW` - Bi-Weekly, * `A` - Annually, * `SA` - Semiannually, * `C` - Commission (only for income product)
        - `statements` Statement[] — List of paystubs received from a payroll provider (only for income product)
          - `id` string — Unique ID
          - `check_number` string, string, nullable — External ID of pay stub from the payroll provider
          - `pay_date` string, date, required — Pay Date
          - `net_pay` string, decimal, nullable — Net pay
          - `net_pay_ytd` string, decimal, nullable — Net pay year to date
          - `gross_pay` string, decimal, nullable — Gross pay
          - `gross_pay_ytd` string, decimal, nullable — Gross pay year to date
          - `bonus` string, decimal, nullable — Bonus
          - `commission` string, decimal, nullable — Commission
          - `hours` string, decimal, nullable — Work hours during a pay period
          - `basis_of_pay` 'S' | 'H' | 'D' | 'W' | 'M' | 'C' | 'null', nullable — Basis of pay: * `S` - Salary, * `H` - Hourly, * `D` - Daily, * `W` - Weekly, * `M` - Monthly, * `C` - Contract,
          - `period_start` string, date, nullable — Period start
          - `period_end` string, date, nullable — Period end
          - `regular` string, decimal, nullable — Regular pay
          - `regular_ytd` string, decimal, nullable — Regular salary year to date
          - `other_pay_ytd` string, decimal, nullable — All other pays year to date
          - `bonus_ytd` string, decimal, nullable — Bonus year to date
          - `commission_ytd` string, decimal, nullable — Commission year to date
          - `overtime` string, decimal, nullable — Overtime pay
          - `overtime_ytd` string, decimal, nullable — Overtime pay year to date
          - `other_pay` string, decimal, nullable — All other pays
          - `earnings` object[], nullable — Earnings for this pay cycle by type
            - `name` string, required — Name of earnings
            - `amount` string, decimal, required — Amount of earnings
            - `category` 'regular' | 'overtime' | 'bonus' | 'commission' | 'other_pay', required — Category of earnings
            - `rate` string, decimal, nullable — Rate of earnings. The number of decimal places varies by payroll provider (`"30.29"`, `"3334.6200"`, `"2"`) and the value can be negative.
            - `units` string, decimal, nullable — Units of earnings. The number of decimal places varies by payroll provider (`"2"`, `"1.0000"`, `"842.5"`) and the value can be negative.
          - `earnings_ytd` object[], nullable — Earnings year to date by type
            - `name` string, required — Name of earnings
            - `amount` string, decimal, required — Amount of earnings
            - `category` 'regular' | 'overtime' | 'bonus' | 'commission' | 'other_pay', required — Category of earnings
            - `rate` string, decimal, nullable — Rate of earnings. The number of decimal places varies by payroll provider (`"30.29"`, `"3334.6200"`, `"2"`) and the value can be negative.
            - `units` string, decimal, nullable — Units of earnings. The number of decimal places varies by payroll provider (`"2"`, `"1.0000"`, `"842.5"`) and the value can be negative.
          - `deductions` object[], nullable — Deductions for this pay cycle by type
            - `name` string, required — Name of the deduction
            - `amount` string, decimal, required — Amount of the deduction
            - `category` 'memo' | 'medicare' | 'retirement' | 'socialsec' | 'federal' | 'state' | 'benefit' | 'garnishment' | 'local' | 'other', required — Category of the deduction
          - `deductions_ytd` object[], nullable — Deductions year to date by type
            - `name` string, required — Name of the deduction
            - `amount` string, decimal, required — Amount of the deduction
            - `category` 'memo' | 'medicare' | 'retirement' | 'socialsec' | 'federal' | 'state' | 'benefit' | 'garnishment' | 'local' | 'other', required — Category of the deduction
          - `md5sum` string, string, nullable — MD5 hash value computed based on the file content
          - `file` string, uri, nullable — Link to a pay stub file (format is specified in the content-type)
          - `derived_fields` string[] — Array of derived fields
          - `missing_data_fields` string[] — List of the data fields which are missing in the payroll API response
        - `annual_income_summary` AnnualIncomeSummary[] — Annual income summary by years (only for income product)
          - `id` string, required — Unique ID
          - `year` integer, required — Income report year
          - `regular` string, decimal, nullable — Regular salary
          - `bonus` string, decimal, nullable — Bonus
          - `commission` string, decimal, nullable — Commission
          - `overtime` string, decimal, nullable — Overtime pay
          - `other_pay` string, decimal, nullable — All other pays
          - `net_pay` string, decimal, nullable — Net pay
          - `gross_pay` string, decimal, nullable — Gross pay
        - `bank_accounts` BankAccount[] — List of bank accounts linked to the employment (only for income product)
          - `account_number` string, required — Account number
          - `routing_number` string — Routing number
          - `account_name` string, nullable — User friendly account name
          - `account_type` 'C' | 'S' | 'null', nullable — Account type: * `C` - Checking account, * `S` - Savings account,
          - `deposit_type` 'E' | 'P' | 'A' | 'null', nullable — Deposit type: * `E` - Entire paycheck, * `P` - Percentage of the paycheck, * `A` - Fixed amount from the paycheck,
          - `deposit_value` string, decimal, nullable — Deposit value
          - `bank_name` string, nullable — Bank name
        - `w2s` TaxDocumentW2[] — List of W-2 forms linked to the employment (only for income product)
          - `file` string, uri, required — Link to a W2 report file (format is specified in the content-type)
          - `md5sum` string, string, required — MD5 hash value computed based on the file content
          - `year` integer, required — Year
          - `wages` string, decimal, nullable — Wages, tips, other compensation (section 1)
          - `federal_tax` string, decimal, nullable — Federal income tax withheld (section 2)
          - `social_security_wages` string, decimal, nullable — Social security wages (section 3)
          - `social_security_tax` string, decimal, nullable — Social security tax withheld (section 4)
          - `medicare_wages` string, decimal, nullable — Medicare wages (section 5)
          - `medicare_tax` string, decimal, nullable — Medicare tax withheld (section 6)
          - `gross_pay` string, decimal, nullable — Gross pay
        - `id` string, required — Unique ID
        - `is_active` boolean, nullable — Indicates whether the employment is still active
        - `job_title` string, nullable — Employee's job title
        - `job_type` 'F' | 'P' | 'S' | 'D' | 'C' | 'V' | 'null', nullable — Employee's job type: * `F` - Full Time, * `P` - Part Time, * `S` - Seasonal, * `D` - Daily (per diem), * `C` - Contract, * `V` - Volunteer
        - `start_date` string, date, nullable — Employee's hire date
        - `original_hire_date` string, date, nullable — Original hire date
        - `end_date` string, date, nullable — Employee's end date
        - `external_last_updated` string, date, nullable — Indicates the date when employment data was last updated on the Payroll Provider side
        - `dates_from_statements` boolean — Indicates whether or not the Employee's hire and/or end dates were derived from first/last pay statements **(Deprecated)**
        - `derived_fields` string[] — Array of derived fields
        - `missing_data_fields` string[] — List of the data fields which are missing in the payroll API response
        - `manager_name` string, nullable — Supervisor's name
        - `profile` Profile, required — Person's identity information
          - `id` string — ID of the object
          - `created_at` string — Person's identity info was retrieved first time (ISO 8601)
          - `updated_at` string — Person's identity info was retrieved last time (ISO 8601)
          - `first_name` string, required — First name
          - `last_name` string, required — Last name
          - `full_name` string, nullable — Full name
          - `middle_initials` string, nullable — Middle initials
          - `email` string, email, nullable — Email address. Normalized to lowercase.
          - `ssn` string, nullable — Social security number — either the full 9 digits or the last 4 digits, depending on what the data source exposes. Digits only, never formatted with dashes.
          - `date_of_birth` string, date, nullable — Date of birth
          - `home_address` object, nullable — Home address
            - `street` string — Street address as provided by the data source. May contain multiple lines separated by `\n` (address line 1 and line 2).
            - `city` string — City as provided by the data source.
            - `state` string — State or region. For US addresses this is typically a 2-letter state code; some data sources return a full state name, an empty string, or omit the key. Non-US regions are returned as provided.
            - `zip` string — Postal code as provided by the data source. Typically a 5-digit US ZIP code; ZIP+4 (`94105-1804`), 9 digits without a separator, and non-US postal codes also occur.
            - `country` string — 2-letter ISO 3166-1 alpha-2 country code. Defaults to `US` when the data source does not specify a country.
        - `company` Company, required — Company information
          - `name` string, required — Company name. Common legal suffixes (LLC, Inc, Corp, and similar) are stripped during normalization.
          - `address` object, required — Company address
            - `street` string — Street address as provided by the data source. May contain multiple lines separated by `\n` (address line 1 and line 2).
            - `city` string — City as provided by the data source.
            - `state` string — State or region. For US addresses this is typically a 2-letter state code; some data sources return a full state name, an empty string, or omit the key. Non-US regions are returned as provided.
            - `zip` string — Postal code as provided by the data source. Typically a 5-digit US ZIP code; ZIP+4 (`94105-1804`), 9 digits without a separator, and non-US postal codes also occur.
            - `country` string — 2-letter ISO 3166-1 alpha-2 country code. Defaults to `US` when the data source does not specify a country.
          - `phone` string, nullable — Company phone number as provided by the data source. Contains digits and may include `,`, `*`, or `#` for extensions. Usually 10 digits, but a country-code prefix (11-digit `1XXXXXXXXXX`) or an extension can make it longer. Never formatted with punctuation or spaces.
          - `ein` string, nullable — Employer Identification Number (EIN) as provided by the data source. Usually 9 digits with no separator; never formatted with dashes. Some payroll providers supply values that contain letters.
    - `insurance` InsuranceResponse, nullable — Insurance verification meta data
      - `id` string, required — Unique ID
      - `product_type` 'insurance' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, required — Date and time when order was created
      - `bridge_token` string — UUID value of bridge token
      - `link_id` string, nullable — Link ID for the connected account
      - `access_token` string, nullable — Access token to perform data refresh
      - `pdf_report` string, uri, nullable — Verification report in PDF format
      - `data_source` 'insurance' | 'docs' | 'null', nullable — Source of data: insurance - insurance data, docs - user uploaded documents.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `last_task_status` 'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' | 'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'switch_deposit' | 'session_expired' | 'null', nullable — Status of the most recent [task](/api-reference/tasks/lifecycle) for the connection. Terminal statuses are `done`, `error`, `login_error`, `account_locked`, `mfa_error`, `config_error`, `no_data`, `unavailable`, `unable_to_reset`, and `not_supported`. The remaining values are in-progress statuses that appear while a verification is still running. Returns `null` when no task exists for the connection yet.
      - `provider_id` string, nullable — Pre-selected ID of a insurance provider
    - `manager` object, nullable — Order manager info associated with an order.
      - `email` string, required — Email of the order manager
      - `name` string — Name of the order manager
    - `financial_accounts` BankResponseDetailed[], nullable, required — List of financial accounts
      - `id` string, required — Unique ID
      - `product_type` 'transactions' | 'assets' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, required — Date and time when order was created
      - `bridge_token` string — UUID value of bridge token
      - `link_id` string, nullable — Link ID for the connected account
      - `access_token` string, nullable — Access token to perform data refresh
      - `pdf_report` string, uri, nullable — Verification report in PDF format
      - `data_source` 'financial_accounts' | 'null', nullable — Source of data: financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `accounts` BankResponseAccount[], nullable — List of bank accounts
        - `id` string, required — Account ID
        - `type` 'CHECKING' | 'SAVINGS' | 'LOAN' | 'CREDIT_CARD' | 'INVESTMENT' | 'LINE_OF_CREDIT' | 'MORTGAGE' | 'PROPERTY' | 'CASH' | 'INSURANCE' | 'PREPAID' | 'CHECKING_LINE_OF_CREDIT' | 'null', nullable — The account's type
        - `subtype` 'MONEY_MARKET' | 'CERTIFICATE_OF_DEPOSIT' | 'AUTO' | 'STUDENT' | 'SMALL_BUSINESS' | 'PERSONAL' | 'PERSONAL_WITH_COLLATERAL' | 'HOME_EQUITY' | 'BOAT' | 'POWERSPORTS' | 'RV' | 'HELOC' | 'PLAN_401_K' | 'PLAN_403_B' | 'PLAN_529' | 'IRA' | 'ROLLOVER_IRA' | 'ROTH_IRA' | 'TAXABLE' | 'NON_TAXABLE' | 'BROKERAGE' | 'TRUST' | 'UNIFORM_GIFTS_TO_MINORS_ACT' | 'PLAN_457' | 'PENSION' | 'EMPLOYEE_STOCK_OWNERSHIP_PLAN' | 'SIMPLIFIED_EMPLOYEE_PENSION' | 'SIMPLE_IRA' | 'PLAN_ROTH_401_K' | 'FIXED_ANNUITY' | 'VARIABLE_ANNUITY' | 'HSA' | 'TAX_FREE_SAVINGS_ACCOUNT' | 'INDIVIDUAL' | 'REGISTERED_RETIREMENT_INCOME_FUND' | 'CASH_MANAGEMENT_ACCOUNT' | 'EMPLOYEE_STOCK_PURCHASE_PLAN' | 'REGISTERED_EDUCATION_SAVINGS_PLAN' | 'PROFIT_SHARING_PLAN' | 'UNIFORM_TRANSFER_TO_MINORS_ACT' | 'PLAN_401_A' | 'SARSEP_IRA' | 'FIXED_ANNUITY_TRADITIONAL_IRA' | 'VARIABLE_ANNUITY_TRADITIONAL_IRA' | 'SEPP_IRA' | 'INHERITED_TRADITIONAL_IRA' | 'FIXED_ANNUITY_ROTH_IRA' | 'VARIABLE_ANNUITY_ROTH_IRA' | 'INHERITED_ROTH_IRA' | 'COVERDELL' | 'ADVISORY_ACCOUNT' | 'BROKERAGE_MARGIN' | 'CHARITABLE_GIFT_ACCOUNT' | 'CHURCH_ACCOUNT' | 'CONSERVATORSHIP' | 'CUSTODIAL' | 'DEFINED_BENEFIT_PLAN' | 'DEFINED_CONTRIBUTION_PLAN' | 'EDUCATIONAL' | 'ESTATE' | 'EXECUTOR' | 'GROUP_RETIREMENT_SAVINGS_PLAN' | 'GUARANTEED_INVESTMENT_CERTIFICATE' | 'HRA' | 'INDEXED_ANNUITY' | 'INVESTMENT_CLUB' | 'IRREVOCABLE_TRUST' | 'JOINT_TENANTS_BY_ENTIRITY' | 'JOINT_TENANTS_COMMUNITY_PROPERTY' | 'JOINT_TENANTS_IN_COMMON' | 'JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP' | 'KEOUGH_PLAN' | 'LIFE_INCOME_FUND' | 'LIVING_TRUST' | 'LOCKED_IN_RETIREMENT_ACCOUNT' | 'LOCKED_IN_RETIREMENT_INVESTMENT_FUND' | 'LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNT' | 'MONEY_PURCHASE_PLAN' | 'PARTNERSHIP' | 'PLAN_409_A' | 'PLAN_ROTH_403_B' | 'REGISTERED_DISABILITY_SAVINGS_PLAN' | 'REGISTERED_LOCKED_IN_SAVINGS_PLAN' | 'REGISTERED_PENSION_PLAN' | 'REGISTERED_RETIREMENT_SAVINGS_PLAN' | 'REVOCABLE_TRUST' | 'ROTH_CONVERSION' | 'SOLE_PROPRIETORSHIP' | 'SPOUSAL_IRA' | 'SPOUSAL_ROTH_IRA' | 'TESTAMENTARY_TRUST' | 'THRIFT_SAVINGS_PLAN' | 'INHERITED_ANNUITY' | 'CORPORATE_ACCOUNT' | 'LIMITED_LIABILITY_ACCOUNT' | 'VEHICLE_INSURANCE' | 'DISABILITY' | 'HEALTH' | 'LONG_TERM_CARE' | 'PROPERTY_AND_CASUALTY' | 'UNIVERSAL_LIFE' | 'TERM_LIFE' | 'WHOLE_LIFE' | 'ACCIDENTAL_DEATH_AND_DISMEMBERMENT' | 'VARIABLE_UNIVERSAL_LIFE' | 'ROTH' | 'ROLLOVER' | 'OTHER' | 'ANNUITY' | 'TRANSFERRABLE_ON_DEATH' | 'null', nullable — The account's subtype
        - `mask` string, nullable — The last four digits of the account number.
        - `balance` string, decimal, nullable — The current balance of the account.
        - `owners` object[] — List of account owners.
          - `full_name` string — Full name of the account owner.
      - `bank_income_sources` BankIncomeInsightsSource[], nullable — List of bank income sources derived from transaction data.
        - `start_date` string, date, required — Minimum of all dates within the specific income sources in the user's bank account for days requested by the client.
        - `end_date` string, date, required — Maximum of all dates within the specific income sources in the user's bank account for days requested by the client.
        - `account_id` string, required — Unique identifier of the account.
        - `income_description` string — Description for the underlying income transactions.
        - `income_category` 'PAYCHECK' | 'RETIREMENT' | 'RENTAL' | 'UNEMPLOYMENT' | 'GOVERNMENT_EMPLOYMENT' | 'GOVERNMENT_BENEFITS' | 'PRIVATE_BENEFITS' | 'EWA_PAYROLL' | 'GIG_ECONOMY' | 'P2P_TRANSFER' | 'TAX_CREDITS' | 'CASH_OR_CHECK' | 'INTEREST' | 'INVESTMENT' | 'OTHER' | 'null', nullable — The income category.
        - `pay_frequency` 'M' | 'SM' | 'W' | 'BW' | 'A' | 'SA' | 'C' | 'null', nullable — Pay frequency: * `M` - Monthly, * `SM` - Semi-Monthly, * `W` - Weekly, * `BW` - Bi-Weekly, * `A` - Annually, * `SA` - Semiannually, * `C` - Commission
        - `next_payment_date` string, date, nullable — The next payment date for the income source.
        - `total_amount` string, decimal, required — Total amount of earnings for the income source of the user in the summary.
        - `iso_currency_code` string, nullable — The ISO 4217 currency code of the amount or balance.
        - `transaction_count` integer, required — Number of income transactions per end user for this source.
        - `historical_summary` object[], required — List of bank statements for each period.
          - `start_date` string, date — The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month.
          - `end_date` string, date — The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month.
          - `total_amount` string, decimal — Total amount of earnings for the income source of the user for the month in the summary.
          - `iso_currency_code` string, nullable — The ISO 4217 currency code of the amount or balance.
          - `transactions` object[] — List of transactions
            - `amount` string, decimal — The settled value of the transaction, denominated in the transactions's currency as stated in iso_currency_code. Negative values when money moves out of the account; positive otherwise.
            - `iso_currency_code` string, nullable — The ISO 4217 currency code of the amount or balance.
            - `date` string, date — The date that the transaction occurred.
            - `check_number` string, nullable — The check number for the transaction.
            - `description` string — A human-readable transaction description.
            - `pending` boolean — True if status of the transaction is PENDING or not set.
            - `transaction_id` string — Unique identifier of the transaction.
        - `historical_average_monthly_income` string, decimal, nullable — Historical average income deposited into the account, per calendar month, typically net of taxes and deductions.
        - `historical_average_monthly_gross_income` string, decimal, nullable — Historical average gross payment amount, per calendar month, predicted based on the transaction data.
        - `forecasted_average_monthly_income` string, decimal, nullable — Forecasted income deposited into the account, per calendar month.
        - `avg_deposit_amount` string, decimal, required — The average amount received per deposit, typically net of taxes and deductions.
        - `avg_gross_deposit_amount` string, decimal — The average gross payment per deposit. Gross pay is predicted based on the transaction data.
        - `employer` Employer, nullable
          - `id` string, nullable, required — Employer ID.
          - `name` string, required — Employer name.
          - `logo_url` string, nullable — Employer logo image.
    - `loan` union — Loan Information
      - object
        - `loan_number` string, nullable, required — Loan identifier
        - `application_number` string, nullable — Application (POS) file number
        - `originator_name` string, nullable — Name of the loan originator
        - `originator_email` string, email, nullable — Email of the loan originator
        - `loan_processor_name` string, nullable — Name of the loan processor
        - `loan_processor_email` string, email, nullable — Email of the loan processor
        - `external_id` string, nullable — External loan ID
      - object
        - `loan_number` string, nullable — Loan identifier
        - `application_number` string, nullable, required — Application (POS) file number
        - `originator_name` string, nullable — Name of the loan originator
        - `originator_email` string, email, nullable — Email of the loan originator
        - `loan_processor_name` string, nullable — Name of the loan processor
        - `loan_processor_email` string, email, nullable — Email of the loan processor
        - `external_id` string, nullable — External loan ID
    - `template_id` string, nullable — ID of the template
    - `cc_emails` string[] — A list of email addresses that will receive carbon copies (CC) of order status updates.
    - `short_share_url` string, nullable — Shortened verification URL to share
    - `voie_report_id` string, nullable — GSE accepted income and employment verification report ID
    - `voa_report_id` string, nullable — Verification of Assets report ID
    - `income_insights_report_id` string, nullable — Income Insights report ID
    - `aim_check_report_id` string, nullable — AIM check report ID
    - `notes` string, nullable — Free text field for notes associated with the order
  - OrderRetrieveWithCertificationResponse — Response returned by GET /v1/orders/{id}/ when the certification query parameter is supplied. Each employment and each bank income source is annotated with a certification object, and each financial account suborder includes an additional_income_sources list of individually certified bank deposits that are not associated with a recognized bank income source.
    - `id` string, required — Unique ID
    - `products` string[], required — Types of products selected for the order
    - `source` 'floify' | 'besmartee' | 'lenderlogix' | 'encompass_consumer_connect' | 'byte' | 'core_logic' | 'xactus' | 'constellation' | 'banno' | 'mx' | 'q2' | 'clutch' | 'accio' | 'encompass' | 'tpo_connect' | 'darkmatter' | 'tazworks' | 'internal' | 'simplenexus' | 'external_webpage' | 'individual' | 'alkami' | 'blue_sage' | 'lodasoft' | 'blend' | 'tidalwave' | 'self_signup', required — Type of the platform (internal, accio, etc.)
    - `order_number` string, nullable — External ID
    - `custom_field` string, nullable — User provided custom field. Must be enabled in the customization section.
    - `client_name` string, required — Client name displayed on the order page
    - `first_name` string, required — First name
    - `last_name` string, required — Last name
    - `user_id` string, required — Unique Truv ID of the user.
    - `bridge_token` string — UUID value of bridge token
    - `share_url` string, nullable, required — Landing page URL to share
    - `created_at` string, date-time, required — Date and time when order was created
    - `updated_at` string, date-time — Date and time when order was updated
    - `canceled_at` string, date-time, nullable — Date and time when order was canceled
    - `completed_at` string, date-time, nullable — Date and time when order was successfully completed
    - `expired_at` string, date-time, required — Date and time when order would expire
    - `is_expired` boolean, required — If order is already expired
    - `user_consent_at` string, date-time, nullable — Date and time when explicit user consent was given
    - `initial_order` string, nullable — ID of an origin order if the order was created by the order data refresh operation
    - `refresh_order` string, nullable — ID of the last refresh order created by the order data refresh operation for the order
    - `employers` EmployerWithCertificationResponse[], required — List of employers with certification-annotated employments.
      - `id` string, required — Unique ID
      - `product_type` 'income' | 'employment' | 'deposit_switch' | 'pll' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, required — Date and time when order was created
      - `bridge_token` string — UUID value of bridge token
      - `link_id` string, nullable — Link ID for the connected account
      - `access_token` string, nullable — Access token to perform data refresh
      - `pdf_report` string, uri, nullable — Verification report in PDF format
      - `data_source` 'payroll' | 'docs' | 'tax' | 'financial_accounts' | 'null', nullable — Source of data: payroll - payroll provider parsing, docs - user uploaded documents, tax - tax documents, financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `last_task_status` 'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' | 'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'switch_deposit' | 'session_expired' | 'null', nullable — Status of the most recent [task](/api-reference/tasks/lifecycle) for the connection. Terminal statuses are `done`, `error`, `login_error`, `account_locked`, `mfa_error`, `config_error`, `no_data`, `unavailable`, `unable_to_reset`, and `not_supported`. The remaining values are in-progress statuses that appear while a verification is still running. Returns `null` when no task exists for the connection yet.
      - `start_date` string, nullable — Employment start date
      - `end_date` string, nullable — Employment start date
      - `company_name` string, nullable — Company name
      - `company_address` object, nullable — Company address
        - `street` string, required — Company location street. Returned exactly as provided when the order was created, and may contain multiple lines separated by `\n`.
        - `city` string, required — Company location city. Returned exactly as provided when the order was created.
        - `state` string, required — Company location state. Typically a 2-letter state code; international region codes such as `NSW` are also accepted. Returned exactly as provided when the order was created.
        - `zip` string, required — Company location zip code. Typically a 5-digit US ZIP code; ZIP+4 and non-US postal codes also occur. Returned exactly as provided when the order was created.
      - `company_domain` string, nullable — Company website domain
      - `company_logo` string, uri, nullable — Company logo URL
      - `employments` object[], nullable, required — List of employments. Each item is annotated with a certification object.
        - `income` string, decimal, nullable — Income amount not including commission or bonuses (only for income product)
        - `income_unit` 'YEARLY' | 'MONTHLY' | 'WEEKLY' | 'DAILY' | 'HOURLY' | 'null', nullable — The pay interval the income field refers to: * `YEARLY` - Annual income, * `MONTHLY` - Monthly income, * `WEEKLY` - Weekly income, * `DAILY` - Daily income, * `HOURLY` - Hourly income (only for income product)
        - `pay_rate` string, decimal, nullable — Payment rate per pay cycle (only for income product)
        - `pay_frequency` 'M' | 'SM' | 'W' | 'BW' | 'A' | 'SA' | 'C' | 'null', nullable — Pay frequency: * `M` - Monthly, * `SM` - Semi-Monthly, * `W` - Weekly, * `BW` - Bi-Weekly, * `A` - Annually, * `SA` - Semiannually, * `C` - Commission (only for income product)
        - `statements` Statement[] — List of paystubs received from a payroll provider (only for income product)
          - `id` string — Unique ID
          - `check_number` string, string, nullable — External ID of pay stub from the payroll provider
          - `pay_date` string, date, required — Pay Date
          - `net_pay` string, decimal, nullable — Net pay
          - `net_pay_ytd` string, decimal, nullable — Net pay year to date
          - `gross_pay` string, decimal, nullable — Gross pay
          - `gross_pay_ytd` string, decimal, nullable — Gross pay year to date
          - `bonus` string, decimal, nullable — Bonus
          - `commission` string, decimal, nullable — Commission
          - `hours` string, decimal, nullable — Work hours during a pay period
          - `basis_of_pay` 'S' | 'H' | 'D' | 'W' | 'M' | 'C' | 'null', nullable — Basis of pay: * `S` - Salary, * `H` - Hourly, * `D` - Daily, * `W` - Weekly, * `M` - Monthly, * `C` - Contract,
          - `period_start` string, date, nullable — Period start
          - `period_end` string, date, nullable — Period end
          - `regular` string, decimal, nullable — Regular pay
          - `regular_ytd` string, decimal, nullable — Regular salary year to date
          - `other_pay_ytd` string, decimal, nullable — All other pays year to date
          - `bonus_ytd` string, decimal, nullable — Bonus year to date
          - `commission_ytd` string, decimal, nullable — Commission year to date
          - `overtime` string, decimal, nullable — Overtime pay
          - `overtime_ytd` string, decimal, nullable — Overtime pay year to date
          - `other_pay` string, decimal, nullable — All other pays
          - `earnings` object[], nullable — Earnings for this pay cycle by type
            - `name` string, required — Name of earnings
            - `amount` string, decimal, required — Amount of earnings
            - `category` 'regular' | 'overtime' | 'bonus' | 'commission' | 'other_pay', required — Category of earnings
            - `rate` string, decimal, nullable — Rate of earnings. The number of decimal places varies by payroll provider (`"30.29"`, `"3334.6200"`, `"2"`) and the value can be negative.
            - `units` string, decimal, nullable — Units of earnings. The number of decimal places varies by payroll provider (`"2"`, `"1.0000"`, `"842.5"`) and the value can be negative.
          - `earnings_ytd` object[], nullable — Earnings year to date by type
            - `name` string, required — Name of earnings
            - `amount` string, decimal, required — Amount of earnings
            - `category` 'regular' | 'overtime' | 'bonus' | 'commission' | 'other_pay', required — Category of earnings
            - `rate` string, decimal, nullable — Rate of earnings. The number of decimal places varies by payroll provider (`"30.29"`, `"3334.6200"`, `"2"`) and the value can be negative.
            - `units` string, decimal, nullable — Units of earnings. The number of decimal places varies by payroll provider (`"2"`, `"1.0000"`, `"842.5"`) and the value can be negative.
          - `deductions` object[], nullable — Deductions for this pay cycle by type
            - `name` string, required — Name of the deduction
            - `amount` string, decimal, required — Amount of the deduction
            - `category` 'memo' | 'medicare' | 'retirement' | 'socialsec' | 'federal' | 'state' | 'benefit' | 'garnishment' | 'local' | 'other', required — Category of the deduction
          - `deductions_ytd` object[], nullable — Deductions year to date by type
            - `name` string, required — Name of the deduction
            - `amount` string, decimal, required — Amount of the deduction
            - `category` 'memo' | 'medicare' | 'retirement' | 'socialsec' | 'federal' | 'state' | 'benefit' | 'garnishment' | 'local' | 'other', required — Category of the deduction
          - `md5sum` string, string, nullable — MD5 hash value computed based on the file content
          - `file` string, uri, nullable — Link to a pay stub file (format is specified in the content-type)
          - `derived_fields` string[] — Array of derived fields
          - `missing_data_fields` string[] — List of the data fields which are missing in the payroll API response
        - `annual_income_summary` AnnualIncomeSummary[] — Annual income summary by years (only for income product)
          - `id` string, required — Unique ID
          - `year` integer, required — Income report year
          - `regular` string, decimal, nullable — Regular salary
          - `bonus` string, decimal, nullable — Bonus
          - `commission` string, decimal, nullable — Commission
          - `overtime` string, decimal, nullable — Overtime pay
          - `other_pay` string, decimal, nullable — All other pays
          - `net_pay` string, decimal, nullable — Net pay
          - `gross_pay` string, decimal, nullable — Gross pay
        - `bank_accounts` BankAccount[] — List of bank accounts linked to the employment (only for income product)
          - `account_number` string, required — Account number
          - `routing_number` string — Routing number
          - `account_name` string, nullable — User friendly account name
          - `account_type` 'C' | 'S' | 'null', nullable — Account type: * `C` - Checking account, * `S` - Savings account,
          - `deposit_type` 'E' | 'P' | 'A' | 'null', nullable — Deposit type: * `E` - Entire paycheck, * `P` - Percentage of the paycheck, * `A` - Fixed amount from the paycheck,
          - `deposit_value` string, decimal, nullable — Deposit value
          - `bank_name` string, nullable — Bank name
        - `w2s` TaxDocumentW2[] — List of W-2 forms linked to the employment (only for income product)
          - `file` string, uri, required — Link to a W2 report file (format is specified in the content-type)
          - `md5sum` string, string, required — MD5 hash value computed based on the file content
          - `year` integer, required — Year
          - `wages` string, decimal, nullable — Wages, tips, other compensation (section 1)
          - `federal_tax` string, decimal, nullable — Federal income tax withheld (section 2)
          - `social_security_wages` string, decimal, nullable — Social security wages (section 3)
          - `social_security_tax` string, decimal, nullable — Social security tax withheld (section 4)
          - `medicare_wages` string, decimal, nullable — Medicare wages (section 5)
          - `medicare_tax` string, decimal, nullable — Medicare tax withheld (section 6)
          - `gross_pay` string, decimal, nullable — Gross pay
        - `id` string, required — Unique ID
        - `is_active` boolean, nullable — Indicates whether the employment is still active
        - `job_title` string, nullable — Employee's job title
        - `job_type` 'F' | 'P' | 'S' | 'D' | 'C' | 'V' | 'null', nullable — Employee's job type: * `F` - Full Time, * `P` - Part Time, * `S` - Seasonal, * `D` - Daily (per diem), * `C` - Contract, * `V` - Volunteer
        - `start_date` string, date, nullable — Employee's hire date
        - `original_hire_date` string, date, nullable — Original hire date
        - `end_date` string, date, nullable — Employee's end date
        - `external_last_updated` string, date, nullable — Indicates the date when employment data was last updated on the Payroll Provider side
        - `dates_from_statements` boolean — Indicates whether or not the Employee's hire and/or end dates were derived from first/last pay statements **(Deprecated)**
        - `derived_fields` string[] — Array of derived fields
        - `missing_data_fields` string[] — List of the data fields which are missing in the payroll API response
        - `manager_name` string, nullable — Supervisor's name
        - `profile` Profile, required — Person's identity information
          - `id` string — ID of the object
          - `created_at` string — Person's identity info was retrieved first time (ISO 8601)
          - `updated_at` string — Person's identity info was retrieved last time (ISO 8601)
          - `first_name` string, required — First name
          - `last_name` string, required — Last name
          - `full_name` string, nullable — Full name
          - `middle_initials` string, nullable — Middle initials
          - `email` string, email, nullable — Email address. Normalized to lowercase.
          - `ssn` string, nullable — Social security number — either the full 9 digits or the last 4 digits, depending on what the data source exposes. Digits only, never formatted with dashes.
          - `date_of_birth` string, date, nullable — Date of birth
          - `home_address` object, nullable — Home address
            - `street` string — Street address as provided by the data source. May contain multiple lines separated by `\n` (address line 1 and line 2).
            - `city` string — City as provided by the data source.
            - `state` string — State or region. For US addresses this is typically a 2-letter state code; some data sources return a full state name, an empty string, or omit the key. Non-US regions are returned as provided.
            - `zip` string — Postal code as provided by the data source. Typically a 5-digit US ZIP code; ZIP+4 (`94105-1804`), 9 digits without a separator, and non-US postal codes also occur.
            - `country` string — 2-letter ISO 3166-1 alpha-2 country code. Defaults to `US` when the data source does not specify a country.
        - `company` Company, required — Company information
          - `name` string, required — Company name. Common legal suffixes (LLC, Inc, Corp, and similar) are stripped during normalization.
          - `address` object, required — Company address
            - `street` string — Street address as provided by the data source. May contain multiple lines separated by `\n` (address line 1 and line 2).
            - `city` string — City as provided by the data source.
            - `state` string — State or region. For US addresses this is typically a 2-letter state code; some data sources return a full state name, an empty string, or omit the key. Non-US regions are returned as provided.
            - `zip` string — Postal code as provided by the data source. Typically a 5-digit US ZIP code; ZIP+4 (`94105-1804`), 9 digits without a separator, and non-US postal codes also occur.
            - `country` string — 2-letter ISO 3166-1 alpha-2 country code. Defaults to `US` when the data source does not specify a country.
          - `phone` string, nullable — Company phone number as provided by the data source. Contains digits and may include `,`, `*`, or `#` for extensions. Usually 10 digits, but a country-code prefix (11-digit `1XXXXXXXXXX`) or an extension can make it longer. Never formatted with punctuation or spaces.
          - `ein` string, nullable — Employer Identification Number (EIN) as provided by the data source. Usually 9 digits with no separator; never formatted with dashes. Some payroll providers supply values that contain letters.
        - `certification` Certification — Income certification decision with a point-in-time snapshot of the certified financial data.
          - `decision` 'representative' | 'not_representative', required — Certification decision for the associated employment, account, bank income source, or additional income source.
          - `rejection_reason` string, nullable — Reason for the rejection, populated when decision is not_representative.
          - `rejection_comment` string, nullable — Free-text comment supplied with the rejection.
          - `certified_data` object, nullable — Snapshot of the financial data at the moment the decision was recorded. Fields depend on the certification target.
            - `type` string — Income type declared at certification time.
            - `is_active` boolean, nullable — Whether the income source was active at certification time. Absent for payroll employment subjects when the source record did not track this flag.
            - `monthly_income` string, decimal — Declared monthly income amount at certification time.
            - `hours_per_month` string, decimal, nullable — Declared hours per month at certification time.
    - `insurance` InsuranceResponse, nullable — Insurance verification meta data
      - `id` string, required — Unique ID
      - `product_type` 'insurance' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, required — Date and time when order was created
      - `bridge_token` string — UUID value of bridge token
      - `link_id` string, nullable — Link ID for the connected account
      - `access_token` string, nullable — Access token to perform data refresh
      - `pdf_report` string, uri, nullable — Verification report in PDF format
      - `data_source` 'insurance' | 'docs' | 'null', nullable — Source of data: insurance - insurance data, docs - user uploaded documents.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `last_task_status` 'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' | 'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'switch_deposit' | 'session_expired' | 'null', nullable — Status of the most recent [task](/api-reference/tasks/lifecycle) for the connection. Terminal statuses are `done`, `error`, `login_error`, `account_locked`, `mfa_error`, `config_error`, `no_data`, `unavailable`, `unable_to_reset`, and `not_supported`. The remaining values are in-progress statuses that appear while a verification is still running. Returns `null` when no task exists for the connection yet.
      - `provider_id` string, nullable — Pre-selected ID of a insurance provider
    - `manager` object, nullable — Order manager info associated with an order.
      - `email` string, required — Email of the order manager
      - `name` string — Name of the order manager
    - `financial_accounts` BankWithCertificationResponse[], nullable, required — List of financial accounts with certification-annotated bank income sources and additional income sources.
      - `id` string, required — Unique ID
      - `product_type` 'transactions' | 'assets' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, required — Date and time when order was created
      - `bridge_token` string — UUID value of bridge token
      - `link_id` string, nullable — Link ID for the connected account
      - `access_token` string, nullable — Access token to perform data refresh
      - `pdf_report` string, uri, nullable — Verification report in PDF format
      - `data_source` 'financial_accounts' | 'null', nullable — Source of data: financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `last_task_status` 'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported' | 'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'switch_deposit' | 'session_expired' | 'null', nullable — Status of the most recent [task](/api-reference/tasks/lifecycle) for the connection. Terminal statuses are `done`, `error`, `login_error`, `account_locked`, `mfa_error`, `config_error`, `no_data`, `unavailable`, `unable_to_reset`, and `not_supported`. The remaining values are in-progress statuses that appear while a verification is still running. Returns `null` when no task exists for the connection yet.
      - `accounts` BankResponseAccountWithCertification[], nullable — List of bank accounts, each annotated with a certification object.
        - `id` string, required — Account ID
        - `type` 'CHECKING' | 'SAVINGS' | 'LOAN' | 'CREDIT_CARD' | 'INVESTMENT' | 'LINE_OF_CREDIT' | 'MORTGAGE' | 'PROPERTY' | 'CASH' | 'INSURANCE' | 'PREPAID' | 'CHECKING_LINE_OF_CREDIT' | 'null', nullable — The account's type
        - `subtype` string, nullable — The account's subtype
        - `mask` string, nullable — The last four digits of the account number.
        - `balance` string, decimal, nullable — The current balance of the account.
        - `owners` object[] — List of account owners.
          - `full_name` string — Full name of the account owner.
        - `certification` Certification — Income certification decision with a point-in-time snapshot of the certified financial data.
          - `decision` 'representative' | 'not_representative', required — Certification decision for the associated employment, account, bank income source, or additional income source.
          - `rejection_reason` string, nullable — Reason for the rejection, populated when decision is not_representative.
          - `rejection_comment` string, nullable — Free-text comment supplied with the rejection.
          - `certified_data` object, nullable — Snapshot of the financial data at the moment the decision was recorded. Fields depend on the certification target.
            - `type` string — Income type declared at certification time.
            - `is_active` boolean, nullable — Whether the income source was active at certification time. Absent for payroll employment subjects when the source record did not track this flag.
            - `monthly_income` string, decimal — Declared monthly income amount at certification time.
            - `hours_per_month` string, decimal, nullable — Declared hours per month at certification time.
      - `bank_income_sources` BankIncomeInsightsSourceWithCertification[], nullable — List of bank income sources derived from transaction data, each annotated with a certification object.
        - `start_date` string, date, required — Minimum of all dates within the specific income sources in the user's bank account for days requested by the client.
        - `end_date` string, date, required — Maximum of all dates within the specific income sources in the user's bank account for days requested by the client.
        - `account_id` string, required — Unique identifier of the account.
        - `income_description` string — Description for the underlying income transactions.
        - `income_category` 'PAYCHECK' | 'RETIREMENT' | 'RENTAL' | 'UNEMPLOYMENT' | 'GOVERNMENT_EMPLOYMENT' | 'GOVERNMENT_BENEFITS' | 'PRIVATE_BENEFITS' | 'EWA_PAYROLL' | 'GIG_ECONOMY' | 'P2P_TRANSFER' | 'TAX_CREDITS' | 'CASH_OR_CHECK' | 'INTEREST' | 'INVESTMENT' | 'OTHER' | 'null', nullable — The income category.
        - `pay_frequency` 'M' | 'SM' | 'W' | 'BW' | 'A' | 'SA' | 'C' | 'null', nullable — Pay frequency: * `M` - Monthly, * `SM` - Semi-Monthly, * `W` - Weekly, * `BW` - Bi-Weekly, * `A` - Annually, * `SA` - Semiannually, * `C` - Commission
        - `next_payment_date` string, date, nullable — The next payment date for the income source.
        - `total_amount` string, decimal, required — Total amount of earnings for the income source of the user in the summary.
        - `iso_currency_code` string, nullable — The ISO 4217 currency code of the amount or balance.
        - `transaction_count` integer, required — Number of income transactions per end user for this source.
        - `historical_summary` object[], required — List of bank statements for each period.
          - `start_date` string, date — The start date of the period covered in this monthly summary. This date will be the first day of the month, unless the month being covered is a partial month because it is the first month included in the summary and the date range being requested does not begin with the first day of the month.
          - `end_date` string, date — The end date of the period included in this monthly summary. This date will be the last day of the month, unless the month being covered is a partial month because it is the last month included in the summary and the date range being requested does not end with the last day of the month.
          - `total_amount` string, decimal — Total amount of earnings for the income source of the user for the month in the summary.
          - `iso_currency_code` string, nullable — The ISO 4217 currency code of the amount or balance.
          - `transactions` object[] — List of transactions
            - `amount` string, decimal — The settled value of the transaction, denominated in the transactions's currency as stated in iso_currency_code. Negative values when money moves out of the account; positive otherwise.
            - `iso_currency_code` string, nullable — The ISO 4217 currency code of the amount or balance.
            - `date` string, date — The date that the transaction occurred.
            - `check_number` string, nullable — The check number for the transaction.
            - `description` string — A human-readable transaction description.
            - `pending` boolean — True if status of the transaction is PENDING or not set.
            - `transaction_id` string — Unique identifier of the transaction.
        - `historical_average_monthly_income` string, decimal, nullable — Historical average income deposited into the account, per calendar month, typically net of taxes and deductions.
        - `historical_average_monthly_gross_income` string, decimal, nullable — Historical average gross payment amount, per calendar month, predicted based on the transaction data.
        - `forecasted_average_monthly_income` string, decimal, nullable — Forecasted income deposited into the account, per calendar month.
        - `avg_deposit_amount` string, decimal, required — The average amount received per deposit, typically net of taxes and deductions.
        - `avg_gross_deposit_amount` string, decimal — The average gross payment per deposit. Gross pay is predicted based on the transaction data.
        - `employer` Employer, nullable
          - `id` string, nullable, required — Employer ID.
          - `name` string, required — Employer name.
          - `logo_url` string, nullable — Employer logo image.
        - `certification` Certification — Income certification decision with a point-in-time snapshot of the certified financial data.
          - `decision` 'representative' | 'not_representative', required — Certification decision for the associated employment, account, bank income source, or additional income source.
          - `rejection_reason` string, nullable — Reason for the rejection, populated when decision is not_representative.
          - `rejection_comment` string, nullable — Free-text comment supplied with the rejection.
          - `certified_data` object, nullable — Snapshot of the financial data at the moment the decision was recorded. Fields depend on the certification target.
            - `type` string — Income type declared at certification time.
            - `is_active` boolean, nullable — Whether the income source was active at certification time. Absent for payroll employment subjects when the source record did not track this flag.
            - `monthly_income` string, decimal — Declared monthly income amount at certification time.
            - `hours_per_month` string, decimal, nullable — Declared hours per month at certification time.
      - `additional_income_sources` AdditionalIncomeSource[], nullable — Income sources assembled from individually certified bank deposits that are not associated with a recognized bank income source.
        - `id` string, required — Unique ID of the additional income source.
        - `income_description` string, required — Human-readable label for the income source, supplied by the user at certification time.
        - `start_date` string, date, required — Date of the earliest certified deposit included in the source.
        - `end_date` string, date, required — Date of the latest certified deposit included in the source.
        - `total_amount` string, decimal, required — Sum of the certified deposit amounts.
        - `iso_currency_code` string, nullable — ISO 4217 currency code for total_amount.
        - `transaction_count` integer, required — Number of certified deposit transactions bundled in this source.
        - `historical_summary` object[], required — Deposits grouped by calendar period.
          - `start_date` string, date
          - `end_date` string, date
          - `total_amount` string, decimal
          - `iso_currency_code` string, nullable
          - `transactions` object[]
            - `amount` string, decimal
            - `iso_currency_code` string, nullable
            - `date` string, date
            - `description` string
            - `pending` boolean
            - `transaction_id` string
            - `check_number` string, nullable
        - `certification` Certification, required — Income certification decision with a point-in-time snapshot of the certified financial data.
          - `decision` 'representative' | 'not_representative', required — Certification decision for the associated employment, account, bank income source, or additional income source.
          - `rejection_reason` string, nullable — Reason for the rejection, populated when decision is not_representative.
          - `rejection_comment` string, nullable — Free-text comment supplied with the rejection.
          - `certified_data` object, nullable — Snapshot of the financial data at the moment the decision was recorded. Fields depend on the certification target.
            - `type` string — Income type declared at certification time.
            - `is_active` boolean, nullable — Whether the income source was active at certification time. Absent for payroll employment subjects when the source record did not track this flag.
            - `monthly_income` string, decimal — Declared monthly income amount at certification time.
            - `hours_per_month` string, decimal, nullable — Declared hours per month at certification time.
    - `loan` union — Loan Information
      - object
        - `loan_number` string, nullable, required — Loan identifier
        - `application_number` string, nullable — Application (POS) file number
        - `originator_name` string, nullable — Name of the loan originator
        - `originator_email` string, email, nullable — Email of the loan originator
        - `loan_processor_name` string, nullable — Name of the loan processor
        - `loan_processor_email` string, email, nullable — Email of the loan processor
        - `external_id` string, nullable — External loan ID
      - object
        - `loan_number` string, nullable — Loan identifier
        - `application_number` string, nullable, required — Application (POS) file number
        - `originator_name` string, nullable — Name of the loan originator
        - `originator_email` string, email, nullable — Email of the loan originator
        - `loan_processor_name` string, nullable — Name of the loan processor
        - `loan_processor_email` string, email, nullable — Email of the loan processor
        - `external_id` string, nullable — External loan ID
    - `template_id` string, nullable — ID of the template
    - `cc_emails` string[] — A list of email addresses that will receive carbon copies (CC) of order status updates.
    - `short_share_url` string, nullable — Shortened verification URL to share
    - `voie_report_id` string, nullable — GSE accepted income and employment verification report ID
    - `voa_report_id` string, nullable — Verification of Assets report ID
    - `income_insights_report_id` string, nullable — Income Insights report ID
    - `aim_check_report_id` string, nullable — AIM check report ID
    - `notes` string, nullable — Free text field for notes associated with the order

## Other responses

- `401` — HTTP 401 Unauthorized
- `403` — HTTP 403 Forbidden
- `404` — HTTP 404 Not Found

---

[API](https://skmtc.net/truv/apis/truv-api.md) · [All operations](https://skmtc.net/truv/apis/truv-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truv/truv-api/versions/b92671dcb52d/schema)