Launch in Production Checklist

Below is a list of recommended steps to take before launching a Truv integration in production. While not all steps may be required for the minimal operation of an application, following these recommendations will help make the Truv integration more robust, secure, efficient, and maintainable.

Production Setup

1. Schedule UX Review

   • Email [email protected] to schedule a UX review session and get tips on implementing Truv Bridge to increase conversion.

2. Test in Development

   • Request a "Development" Access key by heading to the API Keys page and clicking "Request keys." Once approved, use this key to test with live credentials for up to 50 connections.

3. Update Branding

   • Ensure Truv Bridge matches the application's branding. Visit Branding to update colors, application logo, and Link expiration limit for Orders.
   • Fill out the company profile in Settings > Company.

4. Setup Production Environment

   • Ensure the product_type specified in the /v1/bridge-tokens endpoint matches the endpoints being called.
   • Request Production keys via the API Keys page.
   • Configure Truv Bridge and the backend to use the Production environment.
   • Use Production keys found under API Keys.
   • If migrating from Sandbox, remove Sandbox credentials and update unit tests to use the Sandbox environment only.

5. Invite Team Members

   • Add teammates to the dashboard for shared access. See Truv Teams for more details.

Bridge Setup

6. Update Client Name

   • Update the client_name when using the /v1/bridge-tokens endpoint.

7. Assign Unique Identifier

   • Assign a unique identifier for tracking_info to make reports in the Dashboard more accurate.

8. Review UX Best Practices

   • Review UX best practices for the product of choice.

9. Setup Deep Linking

   • Setup deep linking if user data is available beforehand to skip unnecessary screens in Bridge by providing certain fields when requesting a bridge_token.

10. Handle onEvent

    • Handle onEvent to provide a better UX if the user closes Bridge or encounters an error.
    • Handle onEvent events to track conversion metrics.

Webhook Configuration

11. Set Up Webhooks
    • Subscribe to Truv webhooks by navigating to the Webhooks section of the dashboard and entering the URL endpoint for receiving updates.
    • Confirm that the application meets HTTP request timeouts: 1 second for connection timeout and 1 second for read timeout. Ensure the receiving API respects these timeouts to successfully receive webhook events.

Error Handling

12. Implement Retry Logic
    • Implement retry logic or error handling for product API calls, handling intermittent outages or connectivity errors at supported institutions.

Storage & Logging

13. Log Identifiers Securely
    • Log Truv identifiers and IDs properly for security, support requests, and activity log searches. For more details, see Dashboard Logs and Troubleshooting.
    • Store access tokens, Item IDs, and other product-specific tokens securely. Ensure these identifiers are never exposed client-side.
    • Securely log the following identifiers for support and troubleshooting:
      • link_session_id: Included in the onExit, onEvent, and onSuccess callbacks of a Link integration.
      • request_id: Included in all Truv API responses.
      • account_id: Included in all successful Truv API responses related to a specific Item or account.
      • item_id: Included in all successful Truv API responses related to a specific Item.

Delays in Data

14. Handle Data Refresh Tasks
    • For Tasks, wait until the status = done to pull all available data, as many fields are not available when status = full_parse. See more in Data Processing.

Update Mode

15. Implement Update Mode Logic
    • Implement logic to handle errors for data refresh tasks. See more in Refresh Mode and Refresh Data.

Delete Data

16. Remove Unneeded Data
    • If the contract allows, use DELETE /link/{access_token}/ to remove a Link and all associated data.

Post Launch

17. Schedule a meeting with your Customer Success Manager (CSM)
    • Reach out to [email protected] to schedule a session with the dedicated customer success manager.
    • Please inform the CSM of the expected volume so we can monitor the traffic to a seamless experience.