Skip to main content

Documentation Index

Fetch the complete documentation index at: https://truv.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.
AttributeTypeDescription
idstringUnique identifier of template
namestringTemplate name
productsarrayList of products with applied customizable templates
default_for_productsbooleanStatus of customizable template as product default
bridgeobjectConfiguration object for Truv Bridge template
brandingobjectConfiguration object for branding template
ordersobjectConfiguration object for Orders template
document_uploadobjectConfiguration object for Document upload template
created_atdatetimeTimestamp for created customizable template
updated_atdatetimeTimestamp for updated customizable template

​
Endpoints

The table below covers the available endpoints for customizable templates.

​
What templates control

Templates give you fine-grained control over the verification experience across several areas:
AreaCapabilities
Bridge UIFilter search results by provider category, restrict visible employers, customize search header text, toggle the Truv logo and support button
BrandingSet company logo, accent and background colors, button styles, custom end-user agreement, and privacy policy link
CommunicationsCustomize 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 & productsControl which products are available for the template, configure document upload requirements (types, counts, required vs optional), and set report return preferences
Order pagesCustomize the hosted order landing page header, body text, FAQ visibility, and the success/expired screen content
To suppress all Truv-sent notifications and handle communications yourself, enable suppress_user_notifications in the template’s orders configuration.

​
Example response

View the JSON response example below. 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My template",
  "products": [],
  "default_for_products": false,
  "bridge": {
    "texts": {
      "search_header": "string",
      "success_cta": "string"
    },
    "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",
    "support_email": "user@example.com",
    "first_sms": {
      "text": "string",
      "apply_for_reminder": false
    },
    "reminder_sms": {
      "text": "string"
    },
    "first_email": {
      "subject": "string",
      "header": "string",
      "button": "string",
      "caption": "string",
      "apply_for_reminder": false
    },
    "reminder_email": {
      "subject": "string",
      "header": "string",
      "button": "string",
      "caption": "string"
    },
    "landing": {
      "header": "string",
      "body": "string",
      "hide_faq": false,
      "success_screen": {
        "header": "string",
        "body": "string"
      },
      "expired_screen": {
        "header": "string",
        "body": "string"
      }
    },
    "document_upload": {
      "is_enabled": true,
      "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
      }
    }
  },
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}