The Templates object

Find Truv Templates within the Customization section of your Dashboard. Configure Truv Bridge and your order flow for your specific product types when creating a customization template. For example, you can apply different branding and language according to your specific client needs. Your template configurations take priority over other settings, such as universal branding or those from Truv Bridge and Orders.

Attributes

View the payload for retrieving customizable template information.

Attribute	Type	Description
id	string	Unique identifier of template
name	string	Template name
products	array	List of products with applied customizable templates
default_for_products	boolean	Status of customizable template as product default
bridge	object	Configuration object for Truv Bridge template
branding	object	Configuration object for branding template
orders	object	Configuration object for Orders template
document_upload	object	Configuration object for Document upload template. Supported document types include `paystub`, `w2`, `f1099`, `f1040`, `insurance_home_policy`, `insurance_auto_policy`, `volunteer_letter`, `pcs_orders`, `freddie_aim_check`, and `other`
data	object	Settings for returned documents
reports	object	Report settings, including Income Insights configuration
data_sources_flow	object	Data source flow configuration
created_at	datetime	Timestamp for created customizable template
updated_at	datetime	Timestamp for updated customizable template

When the other document type is enabled in document_upload, end users can upload arbitrary documents that don’t fit the other categories. Truv does not parse these documents into structured data (they are captured only) — you can collect the uploaded files through the Uploaded Documents API (GET /v1/links/{link_id}/documents/).

Endpoints

The table below covers the available endpoints for customizable templates.

List all customizable templates - GET /v1/templates/
Create a customizable template - POST /v1/templates/
Retrieve a customizable template - GET /v1/templates/{template_id}/
Update a customizable template - PATCH /v1/templates/{template_id}/
Delete a customizable template - DELETE /v1/templates/{template_id}/

What templates control

Templates give you fine-grained control over the verification experience across several areas:

Area	Capabilities
Bridge UI	Customize search header and per-product success-screen text, and toggle the Truv logo and support button
Branding	Set company logo, accent and background colors, custom end-user agreement, and privacy policy link
Communications	Customize or suppress Truv-sent email and SMS notifications using `suppress_user_notifications`. Configure reminder timing, subject lines, and message text independently for first-touch and follow-up messages
Data & products	Control which products are available for the template, configure document upload requirements (types, counts, required vs optional), and set report return preferences
Order pages	Customize the hosted order landing page header, body text, button labels, FAQ visibility, and the success/expired screen content
Order custom field	Name the order custom field with `custom_field_title`, and restrict its format with `custom_field_pattern`. See Restrict the custom field format
Self-certification	Choose what the user certifies with `certification_mode` (`financial_accounts` or `bank_income`), customize the review screen headers, body copy, and button, toggle the community engagement and non-certifiable income sections, and hide the Uncategorized deposits section. See the Self-Certification guide

To suppress all Truv-sent notifications and handle communications yourself, enable suppress_user_notifications in the template’s orders.notification_settings configuration. Its companion field first_notification_delay_hours is ignored when suppression is on.

Restrict the custom field format

Set orders.custom_field_pattern to accept only order custom_field values in a specific format, such as a 9-digit case number. The pattern is a regular expression: [0-9] means “a digit” and {9} means “exactly nine times”, so [0-9]{9} accepts exactly nine digits. Try patterns on sample values with regex101.

Pattern	Accepts	Rejects
`[0-9]{9}`	`123456789`	`12345678`, `12345678A`
`[A-Z]{2}-[0-9]{6}`	`AB-123456`	`ab-123456`

Set the pattern in the template’s orders object:

{
  "orders": {
    "custom_field_title": "Case Number",
    "custom_field_pattern": "[0-9]{9}"
  }
}

Escape backslashes in JSON. For example, send the pattern \d{9} as "\\d{9}".

The whole value must match the pattern of the order’s template, or the default template if you omit template_id. A mismatch returns 400 Bad Request with an error on custom_field. Orders without custom_field aren’t checked.

Patterns match ASCII characters only and can be up to 100 characters. Truv rejects patterns that could take too long to evaluate, such as nested repeats like (a+)+, backreferences, and lookarounds.

Example response

The bridge.texts object is deprecated. Use bridge.product_settings instead to configure per-product Bridge text; texts will be removed in a future version.

View the JSON response example below.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My template",
  "products": ["income"],
  "default_for_products": false,
  "bridge": {
    "product_settings": [
      {
        "product_type": "assets",
        "data_source": "financial_accounts",
        "texts": {
          "search_header": "Find your bank",
          "success_title": "Success!",
          "success_subtitle": "Your bank account has been connected",
          "success_cta": "Continue"
        }
      }
    ],
    "hide_truv_logo": false,
    "hide_support_button": false
  },
  "branding": {
    "company_name": "string",
    "accent_color": "#aabb00",
    "background_color": "rgba(0, 0, 255, 0.5)",
    "hide_confetti": false,
    "custom_end_user_agreement": {
      "header": "string",
      "url": "string"
    }
  },
  "orders": {
    "link_expiration": "24",
    "custom_field_title": "string",
    "custom_field_pattern": "string",
    "support_email": "user@example.com",
    "first_sms": {
      "text": "string",
      "apply_for_reminder": false
    },
    "reminder_sms": {
      "text": "string"
    },
    "first_email": {
      "subject": "string",
      "title": "string",
      "header": "string",
      "button": "string",
      "caption": "string",
      "apply_for_reminder": false
    },
    "reminder_email": {
      "subject": "string",
      "title": "string",
      "header": "string",
      "button": "string",
      "caption": "string"
    },
    "landing": {
      "header": "string",
      "body": "string",
      "buttons": {
        "connect": "Start verification",
        "add_account": "Agree and link another",
        "try_again": "Retry",
        "review_accounts": "Review sources",
        "submit_accounts": "Send sources"
      },
      "hide_faq": false,
      "success_screen": {
        "header": "string",
        "body": "string"
      },
      "expired_screen": {
        "header": "string",
        "body": "string"
      }
    },
    "self_certification": {
      "main_header": "string",
      "main_body": "string",
      "deposits_header": "string",
      "deposits_body": "string",
      "hide_uncategorized_deposits": false,
      "community_engagement": {
        "enabled": false,
        "text": "string"
      },
      "non_certifiable_income": {
        "enabled": false,
        "header": "string",
        "text": "string"
      },
      "caption": "string",
      "button": "string",
      "certification_mode": "financial_accounts"
    }
  },
  "document_upload": {
    "is_enabled": true,
    "freddie_aim_check": {
      "is_enabled": true,
      "seller_id": "00601"
    },
    "paystub": {
      "is_enabled": true,
      "is_required": true,
      "title": "Upload two most recent paystubs",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload two most recent paystubs?",
      "min_count": 2,
      "max_count": 5
    },
    "w2": {
      "is_enabled": true,
      "is_required": false,
      "title": "Upload two most recent W2s",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload two most recent W2s?",
      "min_count": 2,
      "max_count": 5
    },
    "f1099": {
      "is_enabled": true,
      "is_required": true,
      "title": "Upload two most recent 1099s",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload two most recent 1099s?",
      "min_count": 1,
      "max_count": 1
    },
    "f1040": {
      "is_enabled": true,
      "is_required": true,
      "title": "Upload most recent 1040",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload most recent 1040?",
      "min_count": 1,
      "max_count": 1
    },
    "insurance_home_policy": {
      "is_enabled": true,
      "is_required": true,
      "title": "Upload home insurance policy",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload policy?",
      "min_count": 1,
      "max_count": 1
    },
    "insurance_auto_policy": {
      "is_enabled": true,
      "is_required": true,
      "title": "Upload auto insurance policy",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload policy?",
      "min_count": 1,
      "max_count": 1
    },
    "volunteer_letter": {
      "is_enabled": true,
      "is_required": true,
      "title": "Upload volunteer letter and timesheet",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload volunteer letter and timesheet?",
      "min_count": 1,
      "max_count": 1
    },
    "pcs_orders": {
      "is_enabled": true,
      "is_required": false,
      "title": "Upload PCS orders",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload your PCS orders?",
      "min_count": 1,
      "max_count": 1
    },
    "other": {
      "is_enabled": true,
      "is_required": false,
      "title": "Upload supporting documents",
      "description": "PDF files only under 15 MB.",
      "button": "Upload",
      "submit_title": "Did you upload supporting documents?",
      "min_count": 1,
      "max_count": 1
    }
  },
  "data": {
    "paystubs_count": 6,
    "w2_count": 3,
    "paystubs_ytd_count": 3,
    "extended_history": {
      "statements_history_days": 180
    }
  },
  "reports": {
    "hidden_sections": {
      "deposits": false,
      "large_deposits": false,
      "historical_payment_summary": false
    },
    "days_requested": 60,
    "large_deposit_threshold": 500,
    "transaction_categories": ["Food & Dining", "Travel", "Shopping"],
    "transaction_account_types": ["CHECKING", "SAVINGS"],
    "transaction_account_subtypes": ["FIXED_ANNUITY", "LOCKED_IN_RETIREMENT_ACCOUNT", "PLAN_401_A"],
    "income_insights": {
      "days_requested": 60,
      "consumer_report_permissible_purpose": "WRITTEN_INSTRUCTION_OTHER"
    }
  },
  "data_sources_flow": {
    "employment": {
      "flow": "fallback",
      "data_sources": ["payroll", "docs"]
    },
    "income": {
      "flow": "fallback",
      "data_sources": ["payroll", "financial_accounts"]
    },
    "insurance": {
      "flow": "fallback",
      "data_sources": ["insurance", "docs"]
    }
  },
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}

API Reference

Platform

Income & Employment

Financial Accounts

Document Processing

Direct Deposit Switch

Insurance Verification

The Templates object

Attributes

Endpoints

What templates control

Restrict the custom field format

Example response