v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Customization Templates

List all customization templates

The endpoint returns a list of all customization templates for user.

get/v1/templates/

Query parameters

querystring

Search query by a name.

default_for_productsboolean

Default for products

products'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets'
Example:income

Filter by products

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "bridge": {
        "product_settings": [
          {
            "product_type": "assets",
            "texts": {
              "search_header": "Find your bank",
              "success_title": "Success!",
              "success_subtitle": "Your bank account has been connected",
              "success_cta": "Continue"
            }
          }
        ]
      },
      "branding": {
        "accent_color": "#aabb00",
        "background_color": "rgba(0, 0, 255, 0.5)"
      },
      "orders": {
        "link_expiration": "24",
        "auto_open": "income",
        "skip_behavior": {
          "income": "any",
          "assets": "expire"
        },
        "allow_additional_connections": [
          "income"
        ],
        "notification_settings": {
          "first_notification_delay_hours": 12
        },
        "self_certification": {
          "certification_mode": "financial_accounts"
        },
        "employment_duration_requirement": {
          "minimum_duration": {
            "unit": "months"
          }
        }
      },
      "document_upload": {
        "paystub": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "w2": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "f1099": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "f1040": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "insurance_home_policy": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "insurance_auto_policy": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "volunteer_letter": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        },
        "other": {
          "description": "PDF files only under 15 MB.",
          "button": "Upload",
          "min_count": 2,
          "max_count": 5
        }
      },
      "data": {
        "paystubs_count": 6,
        "w2_count": 3,
        "paystubs_ytd_count": 3,
        "extended_history": {
          "statements_history_days": 180
        },
        "bank_statements_count": 3
      },
      "reports": {
        "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"
        },
        "labeled_transaction_categories": [
          "Food & Dining",
          "Travel",
          "Shopping"
        ]
      },
      "data_sources_flow": {
        "employment": {
          "flow": "fallback",
          "data_sources": [
            "payroll"
          ]
        },
        "income": {
          "flow": "fallback",
          "data_sources": [
            "payroll"
          ]
        },
        "insurance": {
          "flow": "fallback",
          "data_sources": [
            "insurance"
          ]
        }
      },
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z"
    }
  ]
}