TRtruv
Orders

Cancel an order

Changed on

The endpoint cancels the order.

post/v1/orders/{id}/cancel/

Request

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

Response

idstring required

Unique ID

productsstring[] 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' | 'alkami' | 'blue_sage' | 'lodasoft' | 'blend' | 'tidalwave' | 'self_signup' required

Type of the platform (internal, accio, etc.)

order_numberstring nullable

External ID

custom_fieldstring nullable

User provided custom field. Must be enabled in the customization section.

client_namestring required

Client name displayed on the order page

first_namestring required

First name

last_namestring required

Last name

user_idstring required

Unique Truv ID of the user.

bridge_tokenstring

UUID value of bridge token

share_urlstring nullable required

Landing page URL to share

created_atstring date-time required

Date and time when order was created

updated_atstring date-time

Date and time when order was updated

canceled_atstring date-time nullable

Date and time when order was canceled

completed_atstring date-time nullable

Date and time when order was successfully completed

expired_atstring date-time required

Date and time when order would expire

is_expiredboolean required

If order is already expired

user_consent_atstring date-time nullable

Date and time when explicit user consent was given

initial_orderstring nullable

ID of an origin order if the order was created by the order data refresh operation

refresh_orderstring nullable

ID of the last refresh order created by the order data refresh operation for the order

template_idstring nullable

ID of the template

cc_emailsstring[]

A list of email addresses that will receive carbon copies (CC) of order status updates.

short_share_urlstring nullable

Shortened verification URL to share

voie_report_idstring nullable

GSE accepted income and employment verification report ID

voa_report_idstring nullable

Verification of Assets report ID

income_insights_report_idstring nullable

Income Insights report ID

aim_check_report_idstring nullable

AIM check report ID

notesstring nullable

Free text field for notes associated with the order

Example response

{
  "id": "39aa1486ccca4bc19cda071ffc1ba392",
  "products": [
    "income"
  ],
  "source": "floify",
  "order_number": "1534332",
  "client_name": "Unnamed Verifications Inc.",
  "first_name": "John",
  "last_name": "Doe",
  "user_id": "99dd17074ac94aa9ace2621d657c7610",
  "bridge_token": "e4100fccdae94691b4414c7306220c06",
  "share_url": "https://cdn.truv.com/employment.html?bridge_token=63b4af88facb40e48f517c1e8c7abdf4&order_group_id=39aa1486ccca4bc19cda071ffc1ba392",
  "created_at": "2021-04-21T21:45:14.418542Z",
  "updated_at": "2021-04-21T21:45:14.418542Z",
  "canceled_at": "2021-04-22T21:45:14.418542Z",
  "completed_at": "2021-04-22T21:45:14.418542Z",
  "expired_at": "2021-04-24T21:45:14.418542Z",
  "user_consent_at": "2021-04-21T21:45:14.418542Z",
  "initial_order": "f5dc0239e2094dbc90ab2edc1918a9df",
  "refresh_order": "9b96606355b94e8abff8ed8d75aa2027",
  "employers": [
    {
      "id": "ad9f14440d624ec3b0f66e81e44518c7",
      "product_type": "income",
      "status": "pending",
      "suborder_number": "133982343355",
      "created_at": "2021-04-21T22:12:59.346109Z",
      "bridge_token": "e4100fccdae94691b4414c7306220c06",
      "link_id": "e4100fccdae94691b4414c7306220c06",
      "access_token": "e4100fccdae94691b4414c7306220c06",
      "pdf_report": "https://cdn.truv.com/report.pdf",
      "data_source": "payroll",
      "provider": {
        "id": "truv_api",
        "name": "Sandbox Provider",
        "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
      },
      "last_task_status": "done",
      "start_date": "2019-08-24",
      "end_date": "2019-11-27",
      "company_name": "Facebook Demo",
      "company_address": {
        "street": "1 Hacker Way",
        "city": "Menlo Park",
        "state": "CA",
        "zip": "94025"
      },
      "company_domain": "facebook.com",
      "company_logo": "https://cdn.truv.com/company_logos/facebook.svg",
      "employments": [
        {
          "income": "70000.00",
          "income_unit": "YEARLY",
          "pay_rate": "5833.33",
          "pay_frequency": "M",
          "statements": [
            {
              "id": "24d7e80942ce4ad58a93f70ce4115f5c",
              "check_number": "29205182",
              "pay_date": "2018-05-31",
              "net_pay": "12915.44",
              "net_pay_ytd": "39642.52",
              "gross_pay": "18038.33",
              "gross_pay_ytd": "55366.65",
              "bonus": "100.00",
              "commission": "12000.00",
              "hours": "173.33",
              "basis_of_pay": "S",
              "period_start": "2018-05-01",
              "period_end": "2018-05-31",
              "regular": "5833.33",
              "regular_ytd": "29166.65",
              "other_pay_ytd": "700.00",
              "bonus_ytd": "1000.00",
              "commission_ytd": "24000.00",
              "overtime": "45.00",
              "overtime_ytd": "500.00",
              "other_pay": "60.00",
              "earnings": [
                {
                  "name": "Regular",
                  "amount": "5833.33",
                  "category": "regular",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Overtime",
                  "amount": "45.00",
                  "category": "overtime",
                  "rate": "22.50",
                  "units": "2"
                },
                {
                  "name": "Commission",
                  "amount": "12000.00",
                  "category": "commission",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Bonus",
                  "amount": "100.00",
                  "category": "bonus",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Spot Award",
                  "amount": "60.00",
                  "category": "other_pay",
                  "rate": null,
                  "units": null
                }
              ],
              "earnings_ytd": [
                {
                  "name": "Regular",
                  "amount": "29166.65",
                  "category": "regular",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Overtime",
                  "amount": "500.00",
                  "category": "overtime",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Commission",
                  "amount": "24000.00",
                  "category": "commission",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Bonus",
                  "amount": "1000.00",
                  "category": "bonus",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Spot Award",
                  "amount": "700.00",
                  "category": "other_pay",
                  "rate": null,
                  "units": null
                }
              ],
              "deductions": [
                {
                  "name": "Federal Income Tax",
                  "amount": "2705.75",
                  "category": "federal"
                },
                {
                  "name": "Social Security Tax",
                  "amount": "1118.38",
                  "category": "socialsec"
                },
                {
                  "name": "Medicare Tax",
                  "amount": "261.56",
                  "category": "medicare"
                },
                {
                  "name": "VA State Income Tax",
                  "amount": "1037.20",
                  "category": "state"
                }
              ],
              "deductions_ytd": [
                {
                  "name": "Federal Income Tax",
                  "amount": "8305.00",
                  "category": "federal"
                },
                {
                  "name": "Social Security Tax",
                  "amount": "3432.73",
                  "category": "socialsec"
                },
                {
                  "name": "Medicare Tax",
                  "amount": "802.82",
                  "category": "medicare"
                },
                {
                  "name": "VA State Income Tax",
                  "amount": "3183.58",
                  "category": "state"
                }
              ],
              "md5sum": "03639d6a6624f69a54a88ea90bd25e9d",
              "file": "https://cdn.truv.com/paystub_sample.pdf",
              "derived_fields": [
                "basis_of_pay"
              ],
              "missing_data_fields": [
                "earnings_ytd"
              ]
            }
          ],
          "annual_income_summary": [
            {
              "id": "24d7e80942ce4ad58a93f70ce4115f5c",
              "year": 2018,
              "regular": "29166.65",
              "bonus": "1000.00",
              "commission": "24000.00",
              "overtime": "500.00",
              "other_pay": "700.00",
              "net_pay": "39642.52",
              "gross_pay": "55366.65"
            }
          ],
          "bank_accounts": [
            {
              "account_number": "1234567890",
              "routing_number": "123456789",
              "account_name": "My Bank",
              "account_type": "C",
              "deposit_type": "A",
              "deposit_value": "200.00",
              "bank_name": "TD Bank"
            }
          ],
          "w2s": [
            {
              "file": "https://cdn.truv.com/W2_sample.pdf",
              "md5sum": "f65e30c39124ad707ac4b3aeaee923a7",
              "year": 2020,
              "wages": "70000.00",
              "federal_tax": "5830.87",
              "social_security_wages": "70000.00",
              "social_security_tax": "4340.00",
              "medicare_wages": "70000.00",
              "medicare_tax": "1015.00",
              "gross_pay": "70000.00"
            }
          ],
          "id": "24d7e80942ce4ad58a93f70ce4115f5c",
          "job_title": "PR associate",
          "job_type": "F",
          "start_date": "2018-01-01",
          "original_hire_date": "2017-06-21",
          "external_last_updated": "2026-04-23",
          "employed_in_role": "8 years 3 months",
          "derived_fields": [
            "is_active"
          ],
          "missing_data_fields": [
            "w2s"
          ],
          "manager_name": "Jenny McDouglas",
          "profile": {
            "id": "48427a36d43c4d5aa6324bc06c692456",
            "created_at": "2022-06-07T15:00:00Z",
            "updated_at": "2022-06-30T15:00:00Z",
            "first_name": "John",
            "last_name": "Doe",
            "full_name": "John Doe",
            "middle_initials": "K",
            "email": "john.doe@example.com",
            "ssn": "123456789",
            "date_of_birth": "1992-03-03",
            "home_address": {
              "street": "1 Morgan Ave",
              "city": "Los Angeles",
              "state": "CA",
              "zip": "90210",
              "country": "US"
            }
          },
          "company": {
            "name": "Facebook Demo",
            "address": {
              "street": "1 Morgan Ave",
              "city": "Los Angeles",
              "state": "CA",
              "zip": "90210",
              "country": "US"
            },
            "phone": "6503087300",
            "ein": "770493581"
          }
        }
      ]
    }
  ],
  "insurance": {
    "id": "ad9f14440d624ec3b0f66e81e44518c7",
    "product_type": "insurance",
    "status": "pending",
    "suborder_number": "133982343355",
    "created_at": "2021-04-21T22:12:59.346109Z",
    "bridge_token": "e4100fccdae94691b4414c7306220c06",
    "link_id": "e4100fccdae94691b4414c7306220c06",
    "access_token": "e4100fccdae94691b4414c7306220c06",
    "pdf_report": "https://cdn.truv.com/report.pdf",
    "data_source": "insurance",
    "provider": {
      "id": "truv_api",
      "name": "Sandbox Provider",
      "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
    },
    "last_task_status": "done",
    "provider_id": "geico"
  },
  "manager": {
    "email": "john.doe@example.com",
    "name": "John Doe"
  },
  "financial_accounts": [
    {
      "id": "ad9f14440d624ec3b0f66e81e44518c7",
      "product_type": "transactions",
      "status": "pending",
      "suborder_number": "133982343355",
      "created_at": "2021-04-21T22:12:59.346109Z",
      "bridge_token": "e4100fccdae94691b4414c7306220c06",
      "link_id": "e4100fccdae94691b4414c7306220c06",
      "access_token": "e4100fccdae94691b4414c7306220c06",
      "pdf_report": "https://cdn.truv.com/report.pdf",
      "data_source": "financial_accounts",
      "provider": {
        "id": "truv_api",
        "name": "Sandbox Provider",
        "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
      },
      "last_task_status": "done",
      "accounts": [
        {
          "id": "24d7e80942ce4ad58a93f70ce4115f5c",
          "type": "CHECKING",
          "subtype": "MONEY_MARKET",
          "mask": "6789",
          "balance": "5000.00",
          "owners": [
            {
              "full_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",
    "external_id": "c505e0f1b4134fdc853fc87e7d2cc4a5"
  },
  "template_id": "9b96606355b94e8abff8ed8d75aa2027",
  "short_share_url": "https://truv.com/s/BIlEyh1A",
  "voie_report_id": "b19c454a98594b4084b71e3b62873d29",
  "voa_report_id": "b19c454a98594b4084b71e3b62873d29",
  "income_insights_report_id": "b19c454a98594b4084b71e3b62873d29",
  "aim_check_report_id": "FM-1234-39aa1486ccca4bc19cda071ffc1ba392",
  "notes": "To be processed by John Doe"
}

Changes

  • 85952cfcaa91Revision changes
    • info

      removed the session_expired enum value from the // response property for the response status

    • info

      removed the session_expired enum value from the // response property for the response status

    • info

      removed the session_expired enum value from the / response property for the response status

  • 85556e62dac3Revision changes
    • info

      added the optional property //// to the response with the status