TRtruv
Orders

Update an order

Changed on

The endpoint updates the order. Update only available if all employers in one of statuses: pending, sent.

patch/v1/orders/{id}/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/orders/{id}/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Request body

first_namestring
last_namestring
ssnstring nullable
refresh_approvedboolean

Flag that indicates approval for notification to reconnect the account to be sent.

notesstring nullable

Free text field for notes associated with the order

Example request

{
  "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",
    "external_id": "c505e0f1b4134fdc853fc87e7d2cc4a5",
    "funding_date": "2024-08-24"
  }
}

Response

Empty body

Changes

  • 6542a8962887Revision changes
    • info

      added the non-success response with the status

  • b4fe90e78e45Revision changes
    • info

      added the new optional request property /

    • info

      the request property / became nullable

    • info

      the request property / became optional