Sign in

v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB
Orders

Create a data refresh order

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

post/v1/orders/{id}/

Request body

productsstring[]

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.

emailstring email

Subject's email

phonestring

Subject's phone number

include_recent_paystubboolean

A boolean parameter to include the latest statement in the employment report

Example request

{
  "products": [
    "employment"
  ],
  "manager": {
    "email": "john.doe@example.com",
    "name": "John Doe"
  },
  "phone": "4155554193",
  "reports": {
    "voa": {
      "as_of_date": "2024-01-01",
      "large_deposit_threshold": {
        "loan_type": "FHA"
      }
    },
    "income_insights": {
      "consumer_report_permissible_purpose": "ACCOUNT_REVIEW_CREDIT"
    }
  }
}

Response

Data refresh order(s) created

nextstring uri nullable

URL to the next page of results

previousstring uri nullable

URL to the previous page of results

Example response

{
  "next": "https://prod.truv.com/v1/orders/?cursor=cD0yMDI2LTA0LTIx",
  "previous": "https://prod.truv.com/v1/orders/?cursor=cj0xJnA9MjAyNi0wNC0yMQ",
  "results": [
    {
      "id": "39aa1486ccca4bc19cda071ffc1ba392",
      "order_number": "1534332",
      "products": [
        "income",
        "assets"
      ],
      "source": "floify",
      "first_name": "John",
      "last_name": "Doe",
      "short_share_url": "https://truv.com/s/BIlEyh1A",
      "created_at": "2026-04-21T21:45:14.418542Z",
      "canceled_at": "2026-04-22T21:45:14.418542Z",
      "expired_at": "2026-04-23T21:45:14.418542Z",
      "initial_order": "f5dc0239e2094dbc90ab2edc1918a9df",
      "refresh_order": "9b96606355b94e8abff8ed8d75aa2027",
      "manager": {
        "email": "john.doe@example.com",
        "name": "John Doe"
      },
      "loan": {
        "loan_number": "MUUT220700012",
        "application_number": "APP-2207-0001",
        "originator_name": "John Doe",
        "originator_email": "john@example.com",
        "loan_processor_name": "John Doe",
        "loan_processor_email": "john@doe.com"
      },
      "template": {
        "id": "9b96606355b94e8abff8ed8d75aa2027",
        "name": "My template"
      },
      "notes": "To be processed by John Doe",
      "employers": [
        {
          "id": "ad9f14440d624ec3b0f66e81e44518c7",
          "product_type": "income",
          "status": "pending",
          "suborder_number": "133982343355",
          "created_at": "2026-04-21T22:12:59.346109Z",
          "link_id": "e4100fccdae94691b4414c7306220c06",
          "data_source": "payroll",
          "provider": {
            "id": "truv_api",
            "name": "Sandbox Provider",
            "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
          },
          "was_attempted": true
        }
      ],
      "insurance": {
        "id": "ad9f14440d624ec3b0f66e81e44518c7",
        "product_type": "insurance",
        "status": "pending",
        "suborder_number": "133982343355",
        "created_at": "2026-04-21T22:12:59.346109Z",
        "link_id": "e4100fccdae94691b4414c7306220c06",
        "data_source": "insurance",
        "provider": {
          "id": "truv_api",
          "name": "Sandbox Provider",
          "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
        },
        "was_attempted": true
      },
      "financial_accounts": [
        {
          "id": "ad9f14440d624ec3b0f66e81e44518c7",
          "product_type": "assets",
          "status": "pending",
          "suborder_number": "133982343355",
          "created_at": "2026-04-21T22:12:59.346109Z",
          "link_id": "e4100fccdae94691b4414c7306220c06",
          "data_source": "financial_accounts",
          "provider": {
            "id": "truv_api",
            "name": "Sandbox Provider",
            "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
          },
          "was_attempted": true
        }
      ]
    }
  ]
}