---
title: "Create a data refresh order"
method: POST
path: "/v1/orders/{id}/"
tags: ["Orders"]
---

# Create a data refresh order

`POST /v1/orders/{id}/`

The endpoint creates the new order with data populated from the existing order.

## Request body

- CreateRefreshOrder
  - `products` string[] — Indicates the type of product to use for the data refresh order. For the "income" type orders the data refresh order can be "income" or "employment" type. For the "employment" type orders the data refresh order can be only "employment" type.
  - `employers` object[] — List of employers to include in the new refresh order data.
    - `id` string — ID of an employer object for the refresh. Can be found in the order retrieve endpoint "employers" -> "id" field.
    - `suborder_number` string — External ID of an employer object for the refresh. Can be found in the order retrieve endpoint response "employers" -> "suborder_number" field.
  - `financial_accounts` object[] — List of financial accounts to include in the new refresh order data.
    - `id` string — ID of an financial account object for the refresh. Can be found in the order retrieve endpoint response "financial_accounts" -> "id" field.
    - `suborder_number` string — External ID of an financial account object for the refresh. Can be found in the order retrieve endpoint response "financial_accounts" -> "suborder_number" field.
  - `manager` object — Associate new order manager info with a new data refresh order.
    - `email` string, required — Email of the order manager
    - `name` string — Name of the order manager
  - `email` string, email — Subject's email
  - `phone` string — Subject's phone number
  - `include_recent_paystub` boolean — A boolean parameter to include the latest statement in the employment report
  - `reports` CreateRefreshReport — Reports parameters
    - `voa` CreateRefreshVoaRequest — Verification of Assets report parameters
      - `days_requested` integer — The specific duration in days for which the report is requested to be generated.
      - `as_of_date` string, date — The end date for the report period. Start date will be calculated as as_of_date - days_requested. Defaults to current date if not provided.
      - `large_deposit_threshold` object
        - `fixed_amount` integer — Amount that must be met or exceeded for deposits to be marked as large, when OTHER loan type is specified.
        - `sales_price` number — Amount that must be met or exceeded for deposits to be marked as large, when FHA loan type is specified.
        - `qualifying_monthly_income` number — Amount that must be met or exceeded for deposits to be marked as large, when CONVENTIONAL loan type is specified.
        - `loan_type` 'FHA' | 'CONVENTIONAL' | 'OTHER' — Loan type.
      - `is_voe` boolean — A boolean parameter to request a deposit based Verification of Employment report.
      - `request_extended_history` boolean — A boolean parameter to enable extended transaction/statement history. Need to be set for days_requested more than 60 days
      - `account_ids` string[] — List of bank account IDs to include in VOA report. All accounts will be included if not set.
    - `income_insights` CreateIncomeInsightsRequest — Income Insights report parameters.
      - `days_requested` integer, required — The specific duration in days for which the report is requested to be generated.
      - `consumer_report_permissible_purpose` 'ACCOUNT_REVIEW_CREDIT' | 'ACCOUNT_REVIEW_NON_CREDIT' | 'EMPLOYMENT' | 'EXTENSION_OF_CREDIT' | 'LEGITIMATE_BUSINESS_NEED_TENANT_SCREENING' | 'LEGITIMATE_BUSINESS_NEED_OTHER' | 'WRITTEN_INSTRUCTION_PREQUALIFICATION' | 'WRITTEN_INSTRUCTION_OTHER' — Describes the reason you are generating an Income Insights Report for this user.

## Response `200`

Data refresh order(s) created

- PaginatedOrderListResponse
  - `next` string, uri, nullable — URL to the next page of results
  - `previous` string, uri, nullable — URL to the previous page of results
  - `results` OrderListItem[]
    - `id` string, required — Unique ID
    - `order_number` string, nullable — External ID
    - `products` string[], required — Types of products selected for the order
    - `source` 'floify' | 'besmartee' | 'lenderlogix' | 'encompass_consumer_connect' | 'byte' | 'core_logic' | 'xactus' | 'constellation' | 'banno' | 'mx' | 'q2' | 'clutch' | 'accio' | 'encompass' | 'tpo_connect' | 'darkmatter' | 'tazworks' | 'internal' | 'simplenexus' | 'external_webpage' | 'individual' | 'self_signup' | 'alkami' | 'blue_sage' | 'lodasoft' | 'blend' | 'tidalwave', required — Type of the platform (internal, accio, etc.)
    - `custom_field` string, nullable — User provided custom field. Must be enabled in the customization section.
    - `first_name` string, required — First name
    - `last_name` string, required — Last name
    - `short_share_url` string, uri, nullable — Shortened verification URL to share
    - `created_at` string, date-time, required — Date and time when order was created
    - `canceled_at` string, date-time, nullable — Date and time when order was canceled
    - `expired_at` string, date-time, nullable — Date and time when the order is scheduled to expire
    - `initial_order` string, nullable — ID of an origin order if the order was created by the order data refresh operation
    - `refresh_order` string, nullable — ID of the last refresh order created by the order data refresh operation for the order
    - `manager` object, nullable — Order manager info associated with an order.
      - `email` string, email, required — Email of the order manager
      - `name` string — Name of the order manager
    - `loan` OrderListLoanInline, nullable — Loan Information
      - `loan_number` string, nullable — Loan identifier
      - `application_number` string, nullable — Application (POS) file number
      - `originator_name` string, nullable — Name of the loan originator
      - `originator_email` string, email, nullable — Email of the loan originator
      - `loan_processor_name` string, nullable — Name of the loan processor
      - `loan_processor_email` string, email, nullable — Email of the loan processor
    - `template` OrderListTemplateInline, nullable — Customization template applied to the order
      - `id` string — ID of the template
      - `name` string — Name of the template
    - `notes` string, nullable — Free text field for notes associated with the order
    - `employers` OrderListEmployer[] — List of employers
      - `id` string, required — Unique ID
      - `product_type` 'income' | 'employment' | 'deposit_switch' | 'pll' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, date-time, required — Date and time when order was created
      - `link_id` string, nullable — Link ID for the connected account
      - `data_source` 'payroll' | 'docs' | 'tax' | 'financial_accounts' | 'null', nullable — Source of data: payroll - payroll provider parsing, docs - user uploaded documents, tax - tax documents, financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `was_attempted` boolean — Whether the user attempted this connection
    - `insurance` OrderListInsurance, nullable — Insurance connection, when this order includes the insurance product
      - `id` string, required — Unique ID
      - `product_type` 'insurance' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, date-time, required — Date and time when order was created
      - `link_id` string, nullable — Link ID for the connected account
      - `data_source` 'insurance' | 'docs' | 'null', nullable — Source of data: insurance - insurance data, docs - user uploaded documents.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `was_attempted` boolean — Whether the user attempted this connection
    - `financial_accounts` OrderListBank[], nullable — List of financial accounts
      - `id` string, required — Unique ID
      - `product_type` 'transactions' | 'assets' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, date-time, required — Date and time when order was created
      - `link_id` string, nullable — Link ID for the connected account
      - `data_source` 'financial_accounts' | 'null', nullable — Source of data: financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `was_attempted` boolean — Whether the user attempted this connection

## Other responses

- `201`
- `400` — HTTP 400 Bad Request
- `401` — HTTP 401 Unauthorized
- `403` — HTTP 403 Forbidden
- `429` — HTTP 429 Too Many Requests

---

[API](https://skmtc.net/truv/apis/truv-api.md) · [All operations](https://skmtc.net/truv/apis/truv-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truv/truv-api/versions/b92671dcb52d/schema)