Changelog

• Timeline API update:
  • A new endpoint was added to Retrieve events for an order. Submitting an order id will return a list of events for order status updates, notifications, and login attempts. These events are currently shown in the Order Timeline in Truv Dashboard and Encompass. If the include_refresh_orders parameter is set to true, events for associated refresh orders will also be included in the response. 

• Verification of Assets (VOA reports) API update:
  • A new Retrieve Liabilities endpoint was added to provide liability account details (credit cards, loans, balances, and payment information).

• Income Insights Report API updates:
  • Both Retrieve Income Insights Report and Create Income Insights Report now return richer information about income sources.
  • Added avg_deposit_amount and avg_gross_deposit_amount for each bank income source.
  • Introduced an income_category enum to classify income.
  • income_description, income_category, next_payment_date, and iso_currency_code are no longer required fields.
  • avg_deposit_amount is now required.
  • Added a new days_available field under accounts.
• Orders API update:
  • In Create Order, the maximum allowed length for suborder_number in financial institutions was increased from 64 to 512 characters.
• Bank Income Reports API update:
  • A new endpoint was added: Retrieve the Most Recent Bank Income Report. This provides transaction-based income analysis for the latest available report.

• General API updates:
  • Updated the relation_type across across multiple endpoints.
  • Affected endpoints: Retrieve Income Insights Report, Create Income Insights Report, Retrieve Financial Accounts, Retrieve Assets Report, Create Assets Report, Retrieve Bank Income Report.
• Verification of Assets (VOA) reports API updates:
  • Retrieve Assets Report and Create Assets Report now support the balance_as_of field, and the type of ending_daily_balance was changed to number.
  • The minimum value for large_deposit_threshold.fixed_amount is no longer required. The original required default value was 10.
• Customization Templates API updates:
  • The large_deposit_threshold minimum value is no longer required for List Templates, Retrieve a Template, Create a Template, and Update a Template. The original required default value was 10.

• Orders API updates:
  • Added support for notes and introduced blend as a valid value for the source for the following endpoints: Create Order, Retrieve Order, Create Refresh Order, and Cancel Order.
  • Added accounts to financial_accounts, which is used to list the bank accounts for a financial institution. The following endpoints were modified: Retrieve Order, Get List of Orders by SSN

• Balances API update:
  • Updated Retrieve Balances to remove several legacy fields (id, created_at, type, etc.) and introduced required pagination properties: count, next, previous, and results.
• New endpoint update:
  • The following endpoints were added: Get Company Info and Retrieve Auth Data.
• DDS Report update:
  • The deposit_details.deposit_type field is no longer required in the Retrieve DDS Report.
• Financial Accounts and Transactions update:
  • Retrieve Financial Accounts and Retrieve Transactions now support the new TRANSFERRABLE_ON_DEATH subtype.

• Users API updates:
  • first_name and last_name are now required fields in the post body parameters for the Create User request.
• Assets and Employment Verification updates:
  • Added the is_voe flag to support Deposit-based Verification of Employment (DVOE) in VOA and VOE reports, for both Create Assets Report and Retrieve Assets Report responses.
• Assets Reports updates:
  • Introduced the large_deposits flag to allow hiding large deposits in VOA reports. This field is included in the responses of List All Customization Templates and Retrieve a Customization Template, as well as in the request and response bodies of Create a Customization Template and Update a Customization Template endpoints.
• Transaction Details updates:
  • Added the posted_at timestamp to transactions, for both Create Assets Report and Retrieve Assets Report responses.
• Bank Income Reports updates:
  • Included the next_payment_date to represent the next expected payment, in the responses of Retrieve a bank income report, Retrieve User Bank Income Insights Report, and Create User Bank Income Insights Report.
• Account Types updates:
  • Added ANNUITY as a new value to the supported list of account types, returned in the responses of List Financial Accounts, List All Balances, and List All Bank Transactions.

• Customization Templates API (Create and Update endpoints) updates:
  • The bridge section has been changed:
    • An old field, texts, has been deprecated
    • An old field, search has been removed as it was not used
    • A new field, product_settings, has been included to support text customization for different products and data source combinations
• Orders API updates:
  • Now we support the Reports object in the Create a data refresh order endpoint to allow changing parameters for the new report on refresh.

• We’ve introduced new API endpoints that allow you to check the uptime status of our services programmatically:
  • Public API
  • Dashboard
  • Truv Bridge
  • Third Party API

These endpoints provide real-time availability insights, ensuring you stay informed about the status of our systems.

• Verification of Assets (VOA) reports API updates:
  • A new field, large_deposit_threshold, has been added to the Retrieve an assets report endpoint. This field specifies the amount that must be met or exceeded for deposits to be considered large for VOA reports.

• Customization Templates API updates:
  • A new field, large_deposit_threshold, has been added to the report attribute of the CustomizationTemplate for List All, Retrieve, and Create template endpoints.
  • Default values for days_requested and large_deposit_threshold are returned in the Retrieve a customization template endpoint if not provided in the template, ensuring prefilled values where necessary. The default value for days_requested is 60, and for large_deposit_threshold, it’s 500.
  • The minimum value for days_requested in the CustomizationTemplate object has been updated to 30.
  • The hidden_sections object now always includes all fields in API responses.
• Orders API updates:
  • A new field, income_insights_report_id, has been added to the Retrieve an order endpoint to support bank income reports
    • Available by Mar 7th
  • A new endpoint, Retrieve an order invoice, has been added. This endpoint returns an order invoice by the Order’s ID.
  • New values, alkami and blue_sage have been added to the Source list to support a new platform type for the Retrieve an order endpoint.
  • A new field, completed_at, has been added to the OrderResponse object in Order endpoints to store the date and time when an order was successfully completed
• User API updates:
  • A new field, income_insights_report_id, has been added to the Retrieve a user endpoint
    • Available by Mar 7th

• A new field, deleted_at, has been added to the Links object across multiple endpoints. This parameter provides the timestamp when a link is deleted.
  • Users API: List all users and Retrieve a user endpoints
  • Account Links API: List all links and Retrieve a link endpoints
  • Available by Feb 6th
• Income Report API updates:
  • The pay_frequency parameter of the Retrieve Bank Income Report endpoint has been updated to be optional
  • Available by Feb 6th

• Order Refresh API updates:
  • A new parameter, suborder_number, has been introduced to the Employer object to facilitate tracking of employers across refreshes.
• Search companies endpoint updates:
  • A new parameter, id, has been added to support retrieving company details based on the company ID.
• Customization Templates API updates:
  • A new parameter,days_requested, has been added to the report attribute of the CustomizationTemplate. This parameter specifies the number of days included in the VOA report
  • Assets verification product – Updated the DEFAULT_REPORT_DAYS_REQUESTED default value from 61 to 60.
• Retrieve an order and get a list of orders by SSN endpoint updates:
  • A new attribute, user_consent_at, has been added to indicate the exact time the user provided explicit consent.
    • This functionality is behind a feature flag and needs to be enabled for your account, please reach out to customersuccess@truv.com for more details
    • Impacts Order workflow clients
• VOIE and VOA report API updates for both the create and retrieve endpoints:
  • A new field, provider_name, has been added to support the provider’s name in reports
    • Available by Feb 3rd
• Income-Insights report API endpoint:
  • A new endpoint for the Income-Insights report has been added. This report contains income information that a user receives to their bank account(s) across all connected institutions.
  • A new field, provider_name, has been added to store the provider’s name. Additionally, the provider field has been updated to return the data provider ID.
• API performance updates:
  • LIST ALL Users endpoint performance issues have been resolved, ensuring faster and more reliable data retrieval

• Direct deposit and PLL reports API updates:
  • New fields provider and employer have been added to display information about the connected payroll provider or employer
  • New fields account_type, account_name, bank_name, deposit_type, and deposit_value have been added to the initial_accounts list to ensure proper representation of bank details
  • The account_number and routing_number fields in the initial_accounts list have been marked as required.
• A new endpoint for retrieving a list of Orders by SSN has been introduced. It enables LOSs to match by user_id and/or SSN and automatically import loans when Truv is selected.
• LIST ALL users endpoint updates:
  • A new filter parameter, link_exists, has been added to enable the filtering of users based on connection attempts. Set link_exists to true to filter users with attempts or false for users without attempts.

• Bank income report API updated endpoint changes (applicable to Consumer lenders, Auto lenders, and Tenant screeners):
  • A new field, owner, has been added to the Accounts object to support owner details
  • The Total amounts object has been flattened to attributes total_amount and iso_currency_code
  • The Income object now has a new attribute, avg_gross_deposit_amount, to support the average gross payment per deposit.
  • An attribute of the Income object, pay_rate, has been renamed to avg_deposit_amount. It shows the average amount received per deposit, typically net of taxes and deductions.
• Create an Order API updates:
  • The option of sending actions in accounts of the Employer object for updating PLL or DDS products has been added.

• LIST ALL users endpoint updates:
  • A new filter parameters, product_type, has been added to allow filter users by a product type
  • A new filter parameter, provider, has been added to allow filter users by a provider
  • A new filter parameter, query, has been added to support the search:
    • exact match on the following fields: user_id, link_id, email, and external_user_id
    • partial match that searches for users whose first_name and last_name begin with the provided value, regardless of case.
  • external_user_id, first_name, last_name, and email filters have been deprecated and removed.

• LIST ALL user endpoint updates:
  • A time range filter has been added as two new parameters: created_at_lte and created_at_gte to filter users by creation date
• LIST ALL and RETRIEVE user endpoint updates:
  • A new boolean parameter, list_links, has been added. When set to true, it adds the payload from the account links endpoint.
• LIST ALL links endpoint updates:
  • A new object, company_mapping, has been added to the link, containing the data about the company mapping selected in the widget
  • A new object, provider, has been added to support the provider selected in the widget

• Bridge token API updates:
  • An obsolete, PATCH, endpoint has been removed from the API. Only POST endpoints are available for now.
• Companies API updates:
  • A new product_type parameter has been added to search company endpoints. It presents success rate calculation. If not provided, a success rate for income will be used.

• Orders API updates:
  • A new  cc_emails parameter has been added to the Orders API endpoints. It provides a list of email addresses that will receive carbon copies (CC) of order status updates.
• DDS and PLL Report endpoint updates:
  • The existing pdf_report parameter is now included, containing the URL that points to the PDF file with the report.
  • For the DDS Report endpoint, new provider and employer objects have been added to support corresponding information in the report. Both objects include fields: id, name, logo_url.

• CREATE and UPDATE order endpoint updates:
  • The existing external_id parameter is now included within the Loan object. This parameter is used to store the loan ID from external systems (ex. POS).
• LIST ALL and CREATE Customization Templates endpoint updates:
  • A new paystubs_ytd_count parameter has been added to display the # of year-end paystubs for heightened visibility. This parameter has replaced the deprecated paystubs_ytd parameter.

• Orders API updates:
  • An obsolete loan_number attribute has been removed from the Orders API. Now, the Loan object field is used for loan details.

• The new parameter, loan, has been added to update loan data in the Order.
• A new parameter, locale, has been added to the Bridge token API.
• Updated VOIE report:
  • A new parameter, report_type, has been added with values: payroll & aim_check.
  • AIM Check Reports can now be retrieved as JSON or PDF using the fmt parameter.
  • AIM Check Report ID can be retrieved using the report_id parameter.
• Orders API updates:
  • A new  aim_check_report_id parameter has been added to the CREATE and RETRIEVE Orders API. This parameter has been added to support the Report ID required in the Freddie Mac AIM check of the Report and supporting documents, including digitized paystubs and W2s, retrieved by Truv.

• Search endpoint updates:
  • A new, optionalSSO parameter has been added for companies who use single-sign on authentication. This parameter includes the name of the SSO provider.
  • A new success_rate parameter has been added that indicates a strong likelihood of task completion based on recent task history.
  • The existing confidence_level parameter has been improved by calculations based on the success rate.
• Orders API updates:
  • New values: "floify", "besmartee"," lenderlogix", "encompass_consumer_connect", "byte", "core_logic", "xactus", "constellation", "banno", "mx", "q2", "clutch" have been added to the source field of the Orders.
  • Create Order endpoint has been updated to support a new field, reports, that supports Verification of Assets parameter customization.
  • Retrieve an Order endpoint now includes a field, aim_check_report_id, containing the AIM check report identifier.
  • A new boolean option, include_recent_paystub, has been added for the Refresh Order endpoint, available for Verification of Employment only. If enabled, the most recent paystub will be included in the Verification of Employment report.
  • For Create, Retrieve, and Cancel Order endpoints, individual has been added as an option for the source field to support Loan Officer workflows.
• Customization templates updates:
  • A new field, bridge.texts.success_subtitle, has been added into templates. This allows customization of the sub-header on the success screen.
  • The template endpoints have been updated to support the new optional reports field, enabling the customization of certain sections in the borrower report.
• Changes for the Insurance reports:
  • For Insurance, Auto, and Home reports new values were added to the following fields:
    • address_nature of the Addresses object
    • type of the Loss events object
    • policy_type and status of the Policies object
  • For Insurance and Home, new values have been added to the name field in the Dwelling coverages object.
  • For Insurance and Auto, new values have been added to the name field in the Vehicle coverages object.

• For the DDS report, two new fields created_at and updated_at have been added to the links object.
• The subtype query parameter in the Financial Accounts endpoint now supports new enum values: VARIABLE_UNIVERSAL_LIFE, ROTH, ROLLOVER, OTHER.
• Create Order endpoints have been modified to include loan_processor_name and loan_processor_email as part of the Loan object.
• A new refresh_approved boolean field has been added to the Update Order endpoint as an approval indicator for account reconnection notifications.

• All templates API endpoints now support a new data field that controls the count of returned documents.

• The templates API was updated:
  • Orders now support a bank details object and allows the default account to be specified for all connections for the template.
  • Document upload and processing parameters can now be customized for the template using the document_upload object.
• Arequest_extended_history parameter is now supported for the Bridge token API to request financial transaction history for more than 90 days.
• The Loan object for Orders now includes an originator_email field.
• Assets report large deposits detection can be customized by amount, sales price, income and loan type.
• VOIE report now includes a last_task_at parameter to indicate the last transaction date. Additionally, each employment now has two new fields: last_period_end and last_pay_date for the most recent statement.

• The VOA report was updated to include alarge_deposit_threshold parameter to customize the value of the deposit threshold.
• The Financial Accounts endpoint has been updated with a new parameter called full_account_number. This parameter allows users to request unmasked account numbers. Additionally, the response now includes an owners array.
• The Uploaded Documents endpoint now supports insurance documents with two new types: INSURANCE_HOME_POLICY and INSURANCE_AUTO_POLICY
• A waterfall data_sources parameter was added to the employer object when creating an Order.
• Document upload data source docs is now supported as a data_source value for insurance.

• Order object was updated:
  • financial_accounts list is added to the Order, previous bank object is deprecated
  • fannie_voie_report_id parameter is deprecated in favor of voie_report_id
  • source field now can return the value darkmatter for our new upcoming Dark Matter LOS integration
  • use_case parameter is added
• The VOA report was updated:
  • New flags is_direct_deposit and is_subscription are added on the transaction level
  • same_owner_as_requested, direct_deposit_from_employer flags were added on the account level
  • relation_type parameter is added to the owners list

Bank Aggregation.

• New endpoint that allows you to retrieve account information:
  • Optional params allow you to filter accounts by type and subtype
  • Expanded fields for liabilities such as interest rate, credit_limit, loan term and maturity date

• New bank income reports, an income report generated using financial accounts transaction data

Document Upload Updates. We introduced a new API that allows you to directly upload a paystub PDF for parsing

• VOA Reports API reference page now includes owners and summary object fields with updated example responses..
• Updated Orders API reference page with additional object and field attributes.
• Added first_call and reminder_call parameters to the templates API:
  • Defines a customizable template for the first automated phone call message and reminder.
  • Includes properties for text message, delay in seconds after order placement, and a flag to determine whether the message should be used for reminder calls.

• One of Truv’s core differentiators is enabling our customers to go live quickly, as on average it takes a Truv customer four weeks to go live on our consumer-permissioned data platform. We’re able to achieve this accomplishment due to our robust API documentation that clearly outlines the technical specs to implementation.
• To make navigating our documentation easier, the Truv team recently redesigned the API Docs home page. You can now easily navigate to your desired location, whether it’s the quickstart, product guides, or an overview of the Truv Bridge.
• Take a look at our API Documentation

The points below cover changes to pages in the docs

• Design change to Truv documentation landing page
• Published endpoints for Scoring Attributes Report and Financial Accounts
• Launched Uploaded Documents endpoint in API reference
• Added new content Document processing testing to Testing guide and VOIE Implementing Income and Employment Verification Solutions

With requests to add the data for average hours worked per pay period, we’ve now made that verified data more accessible. This provides the information you need to make informed loan decisions.

We’ve added mortgagee and agent name to the insurance endpoint. View the additional fields below.

• Dwellings – replacement_cost_cents, cash_value_cents
• Policies – paid_in_full, named_insureds
• Pulls – addresses_nature, agents

Link ID Endpoints: We’ve added the link_id endpoint to all VOE, VOIE, DDS, PLL, and Insurance Verification reports. We’ve now deprecated previous report endpoints by access token.

New Bank Aggregation Endpoints: We’ve added a transaction endpoint and account endpoint to our Bank Aggregation product. The account endpoint returns balance information in addition to account details. The transaction endpoint lists all transactions for the date specified.

Insurance Endpoint Update: We’ve added the mortgage and agent name to the insurance endpoint.

Reusing Link Across Login Attempts: During a user’s login attempt process, we are now re-using the Link if the username does not change.

Data quality Improvements to:

• pay frequency
• income – regular earnings
• bank accounts and routing number improvements for Oracle Peoplesoft
• SSO improvements – Adomyinfo, b2clogin, Secureauth
• Improvements in CVS integration to include W2 in API responses

We’ve updated our integrations with the following partners. In addition, we’ve improved the Microsoft SSO integration for optimized success rates.

• Starbucks
• SAP Success Factors
• Paylocity
• Workday

We also have added new Customization Template endpoints for use. You can now submit API requests to the endpoints below.

• List all customization templates
• Create, Retrieve, Update, and Delete customization templates
• Update and Delete a logo to the customization template

In our API Reference documentation, we have new Data Provider endpoints. Now, the List all data providers and Retrieve an individual data provider endpoints are available for requests.

In the API Reference section of our API Docs page, you will find new User Management endpoints. Now you can submit API requests to List all users, Create a user, Retrieve an individual user, Update an individual user, Delete an individual user, Create a user report, Retrieve a user report, and Create a bridge token for a user.

In our API reference page, under the User Flow Endpoints section and the Orders sub-section, there is a new endpoint for Create a data refresh order. This will allow you to refresh an individual order based on the Order ID.

On our API reference page, under the User Flow Endpoints section, you will find a new item for Webhooks. If you expand this, you will see new endpoints to List all webhooks, Create a new webhook, Retrieve an individual webhook, Update an individual webhook, and Delete an existing webhook.

Insurance verification report added: We introduced a new product_type called “insurance” which facilitates the verification of insurance policy information from insurance providers. The insurance report endpoint is /v1/link/reports/insurance.

• Insurance Report endpoint
• Insurance Verification implementation guide

• Improved fill rates for data in the statement object for BambooHR, OracleHCM, Paylocity providers
• Improved fill rates for deductions and deductions YTD in the statement object for Team Software provider

Reports API endpoints changed: the reports API for all products now follows the same path structure v1/reports/{product_type}:

• VOIE report endpoint
• VOE report endpoint
• DDS report endpoint
• PLL report endpoint

Individual endpoints added in API reference:

• List Bank Accounts
• Get Employment
• Get Identity
• List Statements
• List Shifts
• Get Statements

product_type is now required to create a refresh task in /refresh/tasks/ Refresh data.

/access-tokens – This endpoint has been deprecated in favor of the /link-access-tokens endpoint. This new endpoint accepts a single {{ definitions.public_token }} instead an array and provides the link_id identifier in the response, which is effective when implementing Webhooks.

/verifications/incomes and /verifications/employments – The provider field in Income and Employment and Employment History has been deprecated and may not be available beyond July 5, 2021.

• Employment, Income and Payroll admin Endpoints – New status fields have been added to each of the endpoints to monitor when Truv is done processing data. Check out the Bridge section for more detail.
• /bridge-tokens/ – The product_type field is now required when calling this endpoint.
• /verifications/incomes/ – Income and Employment now has an annual_income_summary field, which follows the Data schema.

Bridge Token – For internal security reasons the format of the response object had to be changed.